OAuthأصدر رمز وصول
العودة إلى Sofia

OAuth

أصدر رمز وصول

يستبدل client_credentials أو authorization_code مع PKCE أو refresh_token للاستخدام مرة واحدة برمز معتم صالح 3600 ثانية لمساحة عمل واحدة.

POSThttps://api.sofia-post.com/api/v1/oauth/token

الجسم

application/x-www-form-urlencoded, application/json

  • grant_typestringمطلوب

    المنحة المراد استبدالها: client_credentials أو authorization_code أو refresh_token

    القيم المسموحة: client_credentialsauthorization_coderefresh_token

  • client_idstringمطلوب

    معرّف تطبيق العميل

  • client_secretstring

    سر عميل سري (client_secret_post)، أو في ترويسة Authorization: Basic (client_secret_basic)، وليس الاثنين معًا؛ لا شيء لعميل عام

  • scopestring

    الصلاحيات المطلوبة، مفصولة بمسافة؛ عند الغياب: كل صلاحيات المنحة

  • workspace_idstring

    مساحة العمل التي يتصرف فيها الرمز: مطلوبة عندما يملك التطبيق عدة مساحات مع client_credentials، واختيارية عندما يملك واحدة

  • codestring

    authorization_code: الرمز المستلم على عنوان إعادة التوجيه

  • code_verifierstring

    authorization_code: مُتحقِّق PKCE (RFC 7636)

  • redirect_uristring

    authorization_code: عنوان إعادة التوجيه نفسه المستخدم عند التفويض

  • refresh_tokenstring

    refresh_token: رمز التحديث، للاستخدام مرة واحدة

الاستجابة

200application/json

رمز الوصول، مع refresh_token فقط إذا مُنحت offline_access.

  • access_tokenstringمطلوب

    رمز الوصول المعتم

  • token_typestringمطلوب

    دائمًا Bearer

    القيم المسموحة: Bearer

  • expires_innumberمطلوب

    مدة الصلاحية بالثواني

  • scopestringمطلوب

    الصلاحيات الممنوحة، مفصولة بمسافة

  • refresh_tokenstring

    authorization_code وrefresh_token فقط، عند منح offline_access: للاستخدام مرة واحدة، ويتغير مع كل استبدال

400

invalid_request أو invalid_grant أو unsupported_grant_type أو invalid_scope أو unauthorized_client.

401

invalid_client: عميل غير معروف، أو سر خاطئ أو مفقود، أو تطبيق ملغى.