انتقل إلى المحتوى
ShopentlyLearn

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

مخططات البيانات: المصادقة. حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

مخططات البيانات

جلب · رمز الوصول — المصادقة — الاستجابة

ApiResponse_TokenData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataTokenData مطلوب

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

مثال: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

جلب · رمز الوصول — المصادقة — الاستجابة

TokenData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
access_tokenسلسلة نصيةمطلوب

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

مثال: "EXAMPLE_ACCESS_TOKEN"
expires_atسلسلة نصيةمطلوب

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

format: "date-time"
مثال: "2026-01-01T12:00:00Z"
expires_inعدد صحيحاختياري

900 ثانية، أي 15 دقيقة من وقت الإصدار. إرسال الطلبات لا يمدد الصلاحية.

القيمة الافتراضية: 900مثال: 900
rate_limitsTokenRateLimitsData مطلوب

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

مثال: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeسلسلة نصيةاختياري

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

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

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

حدود معدل الطلبات

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

طلبات الرمز في الدقيقة، بما فيها محاولات المصادقة الفاشلة.

minimum: 0maximum: 1000000
مثال: 10
read_per_minuteعدد صحيحمطلوب

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

minimum: 0maximum: 1000000
مثال: 60
write_per_minuteعدد صحيحمطلوب

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

minimum: 0maximum: 1000000
مثال: 10

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

جلب · رمز الوصول — المصادقة — محتوى الطلب

TokenRequest · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
كائنحقول إضافية: لا

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