مرجع API · تطبيقك
إلغاء مفتاح للتطبيق
/v1/keys/{keyId}/revokeيوقف POST /v1/keys/{keyId}/revoke نهائيًا أي مفتاح تابع لتطبيقك، بما فيه المفتاح الذي يوقّع هذا الاستدعاء.
client.Access.RevokeKeyAsync(keyId, reason)- ردّ 200 موقَّع:
{"keyId":"<uuid>","status":"revoked","revokedAt":"<RFC3339>"}. يعيد المفتاح الملغى حالته الحالية. يُرفض المفتاح المُنهى بالرمزkey_not_revocable(409)؛ ويُرفض المفتاح المجهول أو التابع لتطبيق آخر بالرمز نفسهresource_not_found(404). - إلغاء مفتاحك الحالي يتطلب دعوة وتسجيلًا جديدين قبل أن تستطيع التوقيع مجددًا. تتلقى جهة الاتصال الفنية لديك و support@anis.ly بريدًا إلكترونيًا.
المعاملات
| الاسم | الموضع | النوع | ملاحظات |
|---|---|---|---|
keyIdإلزامي | path | UUID | معرّف UUID بأحرف صغيرة مع الشرطات. |
الاستدعاء
موقَّع بمفتاحك، مع رقم استخدام لمرة واحدة (nonce) وبصمة للمحتوى.
الترويسات: Signature-Input، Signature، Content-Digest، Nonce، X-Anis-Date. تضبطها حزم SDK كلها نيابةً عنك.
المحتوى: {"reason":"Suspected compromise"} — نص إلزامي، من 1 إلى 500 حرف بعد إزالة المسافات الطرفية. وقّع بصمة المحتوى برقم استخدام واحد جديد؛ لا يلزم Idempotency-Key ولا صلاحية خاصة للاستدعاء المقبول.
الردود
| الحالة | المعنى | المحتوى |
|---|---|---|
| 200 | نجاح. | KeyRevoked |
| 400 | مرفوض: الاستدعاء الموقّع غير سليم البنية. | مشكلة |
| 401 | مرفوض: لم تتم المصادقة. | مشكلة |
| 403 | مرفوض: غير مسموح. | مشكلة |
| 404 | مرفوض: غير موجود، أو ليس لك. | مشكلة |
| 409 | مرفوض: يتعارض مع الحالة الحالية. | مشكلة |
| 422 | مرفوض: الاستدعاء يخالف قاعدة. | مشكلة |
| 429 | مرفوض: بلغتَ حدًا. | مشكلة |
| 503 | لا قرار: خدمة مطلوبة غير متاحة. | مشكلة |
كل ردّ على هذا الاستدعاء موقَّع من أنيس — النجاح وكل رفض. اشترط وجود التوقيع وتحقّق منه قبل أن تتصرف بناءً على الردّ؛ والردّ بلا توقيع فشل، لا يُعدّ ردًّا (كيف).
حالات الرفض
كل رفض لهذا الاستدعاء مشكلةٌ موقَّعة. ابنِ منطقك على رمزها code؛ وكلٌّ منها يرتبط بصفحة تشرح معناه وما عليك فعله.
| الخطأ | الرمز | الحالة |
|---|---|---|
| بيانات اعتماد غير صالحة | invalid_credentials | 401 |
| استدعاء موقّع غير سليم البنية | malformed_signed_request | 400 |
| عنوان المصدر غير مسموح | source_ip_not_allowed | 403 |
| تجاوزت حدّ الاستدعاءات | rate_limited | 429 |
| اكتُشف تكرار | replay_detected | 409 |
| فشل التحقق | validation_failed | 422 |
| غير موجود | resource_not_found | 404 |
| لا يمكن إلغاء المفتاح | key_not_revocable | 409 |
| الخدمة غير متاحة | dependency_unavailable | 503 |
| انتهت مهلة الاستدعاء | request_timeout | 504 |
| خطأ داخلي | internal_error | 500 |
الأنواع
KeyRevoked
| الحقل | النوع | ملاحظات |
|---|---|---|
keyIdموجود دائمًا | UUID | معرّف المفتاح الملغى التابع لتطبيقك. |
statusموجود دائمًا | string | دائمًا revoked. المفتاح لا يعمل مرة أخرى؛ والتوقيع مجددًا يتطلب تسجيل مفتاح جديد. القيم: revoked |
revokedAtموجود دائمًا | string (date-time) | وقت إلغاء المفتاح، بصيغة RFC3339. |