مخططات البيانات: المصادقة

dataTokenData مطلوب

مثال على الاستجابة · TokenData.

مثال: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:15:00Z","expires_in":1800,"permissions":["orders.order:read"],"rate_limits":{"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15},"token_type":"Bearer","warnings":[]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta مطلوب

البيانات الوصفية للاستجابة.

مثال: {"request_id":"example"}

حقول إضافية: لا

dataTokenRevokedData مطلوب

مثال على الاستجابة · TokenRevokedData.

مثال: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta مطلوب

البيانات الوصفية للاستجابة.

مثال: {"request_id":"example-request"}

حقول إضافية: لا

access_tokenسلسلة نصيةمطلوب

رمز الترويسة Authorization: Bearer. اضبط SHOPENTLY_ACCESS_TOKEN قبل تشغيل المثال المنفصل.

مثال: "EXAMPLE_ACCESS_TOKEN"

expires_atسلسلة نصيةمطلوب

وقت انتهاء الصلاحية بتوقيت UTC. قد تمنع قيود الوصول الحالية استخدام الرمز قبل ذلك.

format: "date-time"

مثال: "2026-01-01T12:15:00Z"

expires_inعدد صحيحمطلوب

مدة الصلاحية الفعلية بالثواني؛ يطلب هذا المثال 1800. لا تمدد الطلبات هذه المدة. يحدد expires_at وقت الانتهاء بتوقيت UTC.

minimum: 300maximum: 3600

مثال: 1800

permissionsمصفوفة <سلسلة نصية> مطلوب

تعرض permissions الصلاحيات الفعلية الحالية: تقاطع صلاحيات المفتاح ومنشئه وخطة المتجر، بما فيها صلاحيات الإضافات النشطة. يُفحص الوصول مجددًا مع كل طلب.

مثال: ["orders.order:read"]

rate_limitsTokenRateLimitsData مطلوب

Engine ≥ 4.143.0. تتضمن كل استجابة للرمز data.rate_limits من سياسة المتجر وقت إصداره. تتشارك جميع المفاتيح هذه الحدود؛ إصدار رمز جديد لا يعيد ضبطها. قد يسري تغيير الخطة قبل انتهاء صلاحية الرمز.

مثال: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeسلسلة نصيةاختياري

Bearer. نظام المصادقة للرمز المعاد.

const: "Bearer"

القيمة الافتراضية: "Bearer"مثال: "Bearer"

warningsمصفوفة <TokenLifetimeWarning > مطلوب

يضبط العدد الصحيح خارج النطاق المدة على 900 ثانية ويعيد warnings مع token.ttl_out_of_range ورابط documentation_url إلى learn.shopently.com. حذف الحقل لا يولد تحذيرًا؛ النوع غير الصحيح يعيد 422.

مثال: []

حقول إضافية: لا

applied_secondsعدد صحيحاختياري

900 s (15 min)

القيمة الافتراضية: 900

codeسلسلة نصيةاختياري

token.ttl_out_of_range

const: "token.ttl_out_of_range"

القيمة الافتراضية: "token.ttl_out_of_range"

documentation_urlسلسلة نصيةاختياري

https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

القيمة الافتراضية: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldسلسلة نصيةاختياري

ttl_seconds

const: "ttl_seconds"

القيمة الافتراضية: "ttl_seconds"

max_secondsعدد صحيحاختياري

3600 s (60 min)

القيمة الافتراضية: 3600

messageسلسلة نصيةاختياري

يضبط العدد الصحيح خارج النطاق المدة على 900 ثانية ويعيد warnings مع token.ttl_out_of_range ورابط documentation_url إلى learn.shopently.com. حذف الحقل لا يولد تحذيرًا؛ النوع غير الصحيح يعيد 422.

القيمة الافتراضية: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsعدد صحيحاختياري

300 s (5 min)

القيمة الافتراضية: 300

حقول إضافية: لا

auth_per_minuteعدد صحيحمطلوب

طلبات إصدار الرموز وإلغائها في الدقيقة، بما فيها محاولات المصادقة الفاشلة. تتشارك العمليتان حد auth.

minimum: 0maximum: 1000000

مثال: 1

read_per_minuteعدد صحيحمطلوب

طلبات القراءة في الدقيقة.

minimum: 0maximum: 1000000

مثال: 2

write_per_minuteعدد صحيحمطلوب

طلبات الكتابة في الدقيقة؛ لا تمنح هذه القيمة صلاحيات الكتابة.

minimum: 0maximum: 1000000

مثال: 15

حقول إضافية: لا

ttl_secondsعدد صحيحاختياري

عدد صحيح اختياري ttl_seconds: من 300 إلى 3600 ثانية (5–60 دقيقة). عند حذف الحقل تكون القيمة الافتراضية 900 ثانية (15 دقيقة).

القيمة الافتراضية: 900مثال: 1800

حقول إضافية: لا

access_tokenسلسلة نصيةمطلوب

أرسل POST /api/v1/auth/revoke مع المفتاح الذي أصدر الرمز في Authorization: ApiKey والرمز في حقل JSON access_token. بعد النجاح يعيد الاستخدام التالي 401. يعيد الرمز المكرر أو المجهول أو التابع لغيرك القيمة نفسها revoked: true؛ لا تُحذف رموز المفاتيح الأخرى.

minLength: 1maxLength: 256

مثال: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

حقول إضافية: لا

revokedقيمة منطقيةاختياري

أرسل POST /api/v1/auth/revoke مع المفتاح الذي أصدر الرمز في Authorization: ApiKey والرمز في حقل JSON access_token. بعد النجاح يعيد الاستخدام التالي 401. يعيد الرمز المكرر أو المجهول أو التابع لغيرك القيمة نفسها revoked: true؛ لا تُحذف رموز المفاتيح الأخرى.

const: true

القيمة الافتراضية: trueمثال: true

حقول إضافية: لا