توثيق واجهة برمجة التطبيقات

هذا هو التوثيق لنقاط النهاية المتاحة لواجهة برمجة التطبيقات، والتي تم بناؤها حول بنية REST. ستعيد جميع نقاط نهاية واجهة برمجة التطبيقات استجابة JSON مع رموز استجابة HTTP القياسية وتحتاج إلى مصادقة Bearer عبر مفتاح API.

Get your own API Key

عنوان URL الأساسي

المصادقة

تتطلب جميع نقاط نهاية واجهة برمجة التطبيقات مفتاح API يتم إرساله بواسطة طريقة مصادقة Bearer.

Authorization: Bearer YOUR_API_KEY

مثال

curl --request GET \
--url 'https://z-bio.link/api/{endpoint}' \
--header 'Authorization: Bearer YOUR_API_KEY' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

مثال

{
    "errors": [
        {
            "title": "\u0644\u064a\u0633 \u0644\u062f\u064a\u0643 \u062d\u0642 \u0627\u0644\u0648\u0635\u0648\u0644 \u0625\u0644\u0649 \u0648\u0627\u062c\u0647\u0629 \u0628\u0631\u0645\u062c\u0629 \u0627\u0644\u062a\u0637\u0628\u064a\u0642\u0627\u062a.",
            "status": 401
        }
    ]
}

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

All API endpoint results work with the UTC timezone unless specified otherwise.

مستخدم

روابط

إحصائيات الروابط

بكسلات التتبع الإعلاني

صفحات البداية

إدارة رموز QR

التوقيعات

بيانات النماذج المجمعة

Notification handlers

إدارة النطاقات المخصصة

فرقي

أعضاء الفريق

عضو الفرق

مدفوعات الحساب

Referred signups

سجلات الحساب

Z-Bio

توثيق واجهة برمجة التطبيقات

المصادقة

Errors