Skip to main content

بزن بریم

به مستندات Zebline REST API خوش آمدید. این API به توسعه‌دهندگان اجازه می‌دهد تا به سرویس‌های Zebline به صورت برنامه‌نویسی شده دسترسی پیدا کنند و آن را در برنامه‌های خود ادغام کنند.

📌 معرفی​

API Zebline امکان ارسال داده‌ها از طریق چهار نقطه دسترسی (endpoint) را فراهم می‌کند. تمامی درخواست‌ها باید با متد POST ارسال شوند.

  • آدرس پایه: https://api.zebline.com/v1/
  • فرمت: JSON
  • احراز هویت: توکن دسترسی (ACCESS_TOKEN) و کد لایسنس (LICENSE_CODE)

🔑 احراز هویت​

احراز هویت در API Zebline به دو روش انجام می‌شود:

  1. افزودن هدر احراز هویت:
    Authorization: ACCESS_TOKEN
  2. ارسال LICENSE_CODE در مسیر URL.

📡 نقاط دسترسی (Endpoints)​

1️⃣ ثبت کاربران جدید​

  • آدرس: https://api.zebline.com/v1/accounts/LICENSE_CODE/users
  • متد: POST
  • توضیح: ایجاد یک کاربر جدید در سیستم.

نمونه درخواست​

curl --location --globoff 'https://api.zebline.com/v1/accounts/LICENSE_CODE/users' \
  --header 'authorization: ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "TX61",
    "firstName": "sample",
    "attributes": {}
  }'

2️⃣ ثبت رویدادها​

  • آدرس: https://api.zebline.com/v1/accounts/LICENSE_CODE/events
  • متد: POST
  • توضیح: ارسال داده‌های رویداد به سیستم.

نمونه درخواست​

curl --location --globoff 'https://api.zebline.com/v1/accounts/LICENSE_CODE/events' \
  --header 'Authorization: ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "TX1",
    "eventName": "page_view",
    "eventTime": "2024-01-01T00:00:00.000000",
    "eventData": {}
  }'

3️⃣ ثبت محصولات​

  • آدرس: https://api.zebline.com/v1/accounts/LICENSE_CODE/products
  • متد: POST
  • توضیح: ارسال اطلاعات محصولات.

نمونه درخواست​

curl --location --globoff 'https://api.zebline.com/v1/accounts/LICENSE_CODE/products' \
  --header 'authorization: ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "productId": "TX1",
    "userId": "TX2",
    "properties": {}
  }'

4️⃣ ثبت اطلاعات محصولات و رویدادها​

  • آدرس: https://api.zebline.com/v1/accounts/LICENSE_CODE/productsevents
  • متد: POST
  • توضیح: ارسال همزمان اطلاعات محصولات و رویدادها.

نمونه درخواست​

curl --location --globoff 'https://api.zebline.com/v1/accounts/LICENSE_CODE/productsevents' \
  --header 'authorization: ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "productId": "TX1",
    "userId": "TX2",
    "eventTime": "2024-01-01T00:00:00.000000",
    "eventName": "vod_watch",
    "eventData": {}
  }'

📥 نمونه پاسخ برای تمامی درخواست‌ها​

{
    "response": {
        "status": "queued",
        "trackID": "bfb7428a-f017-4b4b-b8f5-fd39c4bad20f"
    }
}

❌ مدیریت خطاها​

API کدهای وضعیت استاندارد HTTP را بازمی‌گرداند:

کد وضعیتمعنی
200 OKدرخواست موفقیت‌آمیز بود
201 Createdداده با موفقیت ایجاد شد
400 Bad Requestپارامترهای درخواست نامعتبر هستند
401 Unauthorizedتوکن دسترسی نامعتبر است
403 Forbiddenدسترسی غیرمجاز
404 Not Foundمسیر درخواست نامعتبر است
500 Internal Server Errorخطای داخلی سرور

نمونه پاسخ خطا:

{
  "error": "توکن دسترسی نامعتبر است",
  "code": 401
}

📞 پشتیبانی و تماس​

در صورت بروز مشکلات یا سوالات:

✅ امروز شروع کنید و Zebline را در برنامه خود ادغام کنید! 🚀