المصادقة

يتطلب الوصول إلى Partner API المصادقة باستخدام مفاتيح API السرية. أنشئ مفاتيحك وأدرها من خلال Partner Console.

تعمل مفاتيح API بوصفها بيانات اعتمادك للوصول إلى موارد الشريك. ولكل مفتاح وصول مقيّد إلى بيانات منظمة محددة، ويمكن إلغاء تنشيطه فورًا عند الحاجة.

تعامل مع مفاتيح API بحذر، فهي توفّر وصولًا كاملًا إلى حسابك! لا تكشف هذه المفاتيح أبدًا في المستودعات العامة، أو في التطبيقات من جهة العميل، أو في أي مكان قد تتعرض فيه للاختراق.

صادِق على الطلبات باستخدام HTTP Basic Auth بتمرير مفتاح API بوصفه اسم المستخدم. واترك كلمة المرور فارغة.

لا تقبل API إلا اتصالات HTTPS الآمنة. تُرفض طلبات HTTP العادية، وكذلك أي طلبات تفتقر إلى بيانات اعتماد المصادقة الصحيحة.

مثال على طلب

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

التحقق من المفتاح السري

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }