توثيق API
دمج منصة موجز في تطبيقاتك باستخدام RESTful API الخاص بنا
الإصدار 1.0
REST API
محدود المعدل
البدء
عنوان URL الأساسي
https://api.mujaz.com/v1المصادقة
قم بتضمين مفتاح API الخاص بك في رأس التفويض:
Authorization: Bearer your-api-keyحدود المعدل
1000 طلب في الساعة لكل مفتاح API
نقاط النهاية
GET
/api/newslettersاسترجاع جميع الرسائل الإخبارية
POST
/api/newslettersإنشاء رسالة إخبارية جديدة
GET
/api/subscribersاسترجاع قائمة المشتركين
POST
/api/subscribersإضافة مشترك جديد
POST
/api/newsletters/{id}/sendإرسال رسالة إخبارية إلى المشتركين
GET
/api/analytics/newsletters/{id}الحصول على تحليلات الرسائل الإخبارية
GET
/api/newslettersاسترجاع جميع الرسائل الإخبارية
المعلمات
pageاختياريlimitاختياريstatusاختياريالاستجابة
{
"newsletters": [
{
"id": "newsletter_123",
"title": "Weekly Update",
"status": "published",
"created_at": "2024-01-15T10:00:00Z"
}
],
"total": 25,
"page": 1,
"limit": 10
}أمثلة SDK
// Install: npm install @mujaz/api-client
import { MujazAPI } from '@mujaz/api-client';
const api = new MujazAPI('your-api-key');
// Create a newsletter
const newsletter = await api.newsletters.create({
title: 'Weekly Update',
content: '<h1>Hello World</h1>',
subject: 'This Week’s Update'
});
// Send newsletter
await api.newsletters.send(newsletter.id);
// Get analytics
const analytics = await api.analytics.getNewsletter(newsletter.id);هل تحتاج إلى دعم API؟
هل لديك أسئلة حول API الخاص بنا؟ فريق دعم المطورين لدينا هنا للمساعدة.