انتقل إلى المحتوى
ShopentlyLearn
العربية

المصادقة

أنشئ مفتاح API

تحتاج إلى مفتاح API لربط تطبيقك بالمتجر. اختر صلاحياته في لوحة الإدارة لتحدد البيانات التي يمكن للتطبيق قراءتها وما يمكنه تغييره في المتجر.

يمكنك أيضًا تحديد عناوين IP التي سيتصل منها التطبيق بواجهة API. إذا أدخلتها، فلن يعمل المفتاح إلا من هذه العناوين. ثم أنشئ مفتاح API.

احصل على رمز وصول

يتيح لك رمز الوصول إرسال الطلبات دون إرسال مفتاح API في كل طلب. ويمكنك إلغاء الرمز عندما لا تعود بحاجة إليه.

تحصل مع رمز الوصول على الأذونات وحدود طلبات API الخاصة بمتجرك. يتيح لك

POST/api/v1/auth/token

طلب cURL 

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/token \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"ttl_seconds":1800}'

الاستجابة 

{
  "data": {
    "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": []
  },
  "meta": {
    "request_id": "example"
  }
}

أرسل طلبات API

استخدم الرمز الذي حصلت عليه عند إرسال طلبات API. التزم بـحدود الطلبات الخاصة بمتجرك. يعتمد الوصول إلى العمليات أيضًا على أذونات خطتك.

إذا احتجت إلى اختيار لغة أو سوق لطلباتك، فاجلب سياق المتجر. ستحصل على اللغات والأسواق المتاحة مع رموزها ومعرّفاتها.

ألغِ الرمز

إلغاء الرمز اختياري. إذا كنت تستخدمه لمهمة واحدة، فننصح بإلغائه بعد انتهاء العمل. إذا لم تلغِ الرمز يدويًا، فسيظل صالحًا حتى نهاية المدة المحددة. وبعدها لن تتمكن من استخدامه.

POST/api/v1/auth/revoke

طلب cURL 

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/revoke \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"access_token":"EXAMPLE_ACCESS_TOKEN"}'

الاستجابة 

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}