مرجع API · تطبيقك

قراءة ملفّك

GET/v1/profile

هوية تطبيقك، والحساب التجاري لدى أنيس الذي يعمل له، والصلاحيات التي تمنحها سياسته الحالية. تُعاد الصلاحيات مع كل استدعاء، فاقرأها ولا تحفظها مؤقتًا.

الصلاحيةprofile:read
المصادقةقراءة موقَّعة
حدود الموظفين التي يُحتسب ضمنهاكل الاستدعاءات
حزمة SDK لـ ‎.NETanis.Profile.GetAsync()

الاستدعاء

موقَّعة بمفتاحك. بلا محتوى وبلا رقم استخدام لمرة واحدة (nonce).

الترويسات: Signature-Input، Signature، X-Anis-Date، Accept-Language (اختياري). تضبطها حزم SDK كلها نيابةً عنك.

المحتوى: لا يوجد.

الردود

الحالةالمعنىالمحتوى
200نجاح.Profile
401مرفوض: لم تتم المصادقة.مشكلة
403مرفوض: غير مسموح.مشكلة
429مرفوض: بلغتَ حدًا.مشكلة
503لا قرار: خدمة مطلوبة غير متاحة.مشكلة

كل ردّ موقَّع من أنيس؛ وتتحقق منه حزم SDK قبل أن يصلك.

حالات الرفض

كل رفض مشكلةٌ موقَّعة. ابنِ منطقك على رمزها code؛ وكلٌّ منها يرتبط بصفحة تشرح معناه وما عليك فعله.

الخطأالرمزالحالة
بيانات اعتماد غير صالحةinvalid_credentials401
صلاحية غير كافيةinsufficient_scope403
عنوان المصدر غير مسموحsource_ip_not_allowed403
تجاوزت حدّ الاستدعاءاتrate_limited429
الحساب غير مخوَّلbinding_not_authorized403
الخدمة غير متاحةdependency_unavailable503
انتهت مهلة الاستدعاءrequest_timeout504
خطأ داخليinternal_error500

الأنواع

Profile

الحقلالنوعملاحظات
partnerموجود دائمًاobjectالشريك الذي يتبع له تطبيقك.
partner.idموجود دائمًاUUIDمعرّف الشريك.
applicationموجود دائمًاobjectتطبيقك.
application.idموجود دائمًاUUIDمعرّف تطبيقك. يبقى كما هو حين تُستبدل مفاتيحك.
application.scopesموجود دائمًاlist of stringالصلاحيات التي يملكها تطبيقك الآن. اقرأها ولا تحفظها مؤقتًا: يسري التغيير من استدعائك التالي.
ownerAccountobjectالحساب التجاري لدى أنيس الذي يعمل له تطبيقك، حين يُعرض.
ownerAccount.idUUIDمعرّف الحساب التجاري.
ownerAccount.displayNamestringاسم الحساب التجاري.
documentationVersionstringإصدار هذا التوثيق الذي تطابقه نسخة نشر أنيس التي استدعيتها.