مرجع API · تطبيقك
قراءة ملفّك
GET
/v1/profileهوية تطبيقك، والحساب التجاري لدى أنيس الذي يعمل له، والصلاحيات التي تمنحها سياسته الحالية. تُعاد الصلاحيات مع كل استدعاء، فاقرأها ولا تحفظها مؤقتًا.
الصلاحية
profile:readالمصادقةقراءة موقَّعة
حدود الموظفين التي يُحتسب ضمنهاكل الاستدعاءات
حزمة SDK لـ .NET
anis.Profile.GetAsync()الاستدعاء
موقَّعة بمفتاحك. بلا محتوى وبلا رقم استخدام لمرة واحدة (nonce).
الترويسات: Signature-Input، Signature، X-Anis-Date، Accept-Language (اختياري). تضبطها حزم SDK كلها نيابةً عنك.
المحتوى: لا يوجد.
الردود
| الحالة | المعنى | المحتوى |
|---|---|---|
| 200 | نجاح. | Profile |
| 401 | مرفوض: لم تتم المصادقة. | مشكلة |
| 403 | مرفوض: غير مسموح. | مشكلة |
| 429 | مرفوض: بلغتَ حدًا. | مشكلة |
| 503 | لا قرار: خدمة مطلوبة غير متاحة. | مشكلة |
كل ردّ موقَّع من أنيس؛ وتتحقق منه حزم SDK قبل أن يصلك.
حالات الرفض
كل رفض مشكلةٌ موقَّعة. ابنِ منطقك على رمزها code؛ وكلٌّ منها يرتبط بصفحة تشرح معناه وما عليك فعله.
| الخطأ | الرمز | الحالة |
|---|---|---|
| بيانات اعتماد غير صالحة | invalid_credentials | 401 |
| صلاحية غير كافية | insufficient_scope | 403 |
| عنوان المصدر غير مسموح | source_ip_not_allowed | 403 |
| تجاوزت حدّ الاستدعاءات | rate_limited | 429 |
| الحساب غير مخوَّل | binding_not_authorized | 403 |
| الخدمة غير متاحة | dependency_unavailable | 503 |
| انتهت مهلة الاستدعاء | request_timeout | 504 |
| خطأ داخلي | internal_error | 500 |
الأنواع
Profile
| الحقل | النوع | ملاحظات |
|---|---|---|
partnerموجود دائمًا | object | الشريك الذي يتبع له تطبيقك. |
partner.idموجود دائمًا | UUID | معرّف الشريك. |
applicationموجود دائمًا | object | تطبيقك. |
application.idموجود دائمًا | UUID | معرّف تطبيقك. يبقى كما هو حين تُستبدل مفاتيحك. |
application.scopesموجود دائمًا | list of string | الصلاحيات التي يملكها تطبيقك الآن. اقرأها ولا تحفظها مؤقتًا: يسري التغيير من استدعائك التالي. |
ownerAccount | object | الحساب التجاري لدى أنيس الذي يعمل له تطبيقك، حين يُعرض. |
ownerAccount.id | UUID | معرّف الحساب التجاري. |
ownerAccount.displayName | string | اسم الحساب التجاري. |
documentationVersion | string | إصدار هذا التوثيق الذي تطابقه نسخة نشر أنيس التي استدعيتها. |