الحساب

من أنا

يصف الرمز المستدعي: نوعه وتطبيقه والشخص الذي يتصرف نيابةً عنه ومساحات عمله وصلاحياته ووضعه وانتهاءه. يقرؤه أي رمز صالح.

GEThttps://api.sofia-post.com/api/v1/me

من أنا

curl -X GET 'https://api.sofia-post.com/api/v1/me' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

{
  "tokenType": "personal_key",
  "application": {
    "id": "string",
    "clientId": "sofia_app_live_3f9c…",
    "name": "Atelier CRM"
  },
  "user": {
    "id": "string"
  },
  "coverage": "workspace",
  "workspaces": [
    {
      "id": "string",
      "name": "Bistrot Lumière Lyon 2e"
    }
  ],
  "scopes": [
    "establishments:read"
  ],
  "mode": "test"
}

من أنا

curl --request GET \
  --url 'https://api.sofia-post.com/api/v1/me' \
  --header "Authorization: Bearer $SOFIA_API_KEY"

{
  "tokenType": "personal_key",
  "application": {
    "id": "string",
    "clientId": "sofia_app_live_3f9c…",
    "name": "Atelier CRM"
  },
  "user": {
    "id": "string"
  },
  "coverage": "workspace",
  "workspaces": [
    {
      "id": "string",
      "name": "Bistrot Lumière Lyon 2e"
    }
  ],
  "scopes": [
    "establishments:read"
  ],
  "mode": "test"
}

استدعاؤك الأول

أرسل المفتاح في الترويسة Authorization. GET /v1/me يخبرك لمن يعمل المفتاح، وما Workspaces الخاصة به وأذوناته.

curl https://api.sofia-post.com/api/v1/me \
  -H "Authorization: Bearer $SOFIA_API_KEY"

{
  "tokenType": "personal_key",
  "user": { "id": "cmo7qiltc0000sb1p7zdx1aw4" },
  "coverage": "account",
  "workspaces": [{ "id": "cmo7qiltc0000sb1p7zdx1aw4", "name": "160 food" }],
  "scopes": ["establishments:read", "posts:read", "posts:write"],
  "mode": "live",
  "expiresAt": "2026-11-09T20:09:05.644Z"
}

ليس لديك مفتاح بعد؟ أنشئه في الإعدادات › API › الوصول الشخصي: انظر المصادقة.

التفويضات

Authorizationstringheaderمطلوب
مفتاحك الشخصي أو رمز وصول OAuth، يُرسل كـ Bearer <token>.

الاستجابة

هوية الرمز المستدعي ونطاق صلاحياته.

tokenTypestringمطلوب
نوع الرمز: personal_key أو authorization_code أو client_credentials
القيم المسموحة: personal_keyauthorization_codeclient_credentials
applicationobjectمطلوب
التطبيق وراء الرمز
عرض الخصائص الفرعية
- idstringمطلوب
  معرّف التطبيق (أو المفتاح الشخصي)
- clientIdstringمطلوب
  قيمة client_id للتطبيق
- namestringمطلوب
  اسم التطبيق
userobjectمطلوب
الشخص الذي يتصرف الرمز نيابةً عنه
عرض الخصائص الفرعية
- idstringمطلوب
  الشخص الذي يتصرف الرمز نيابةً عنه: كاتب المفتاح، أو من منح الموافقة
coveragestringمطلوب
workspace: مساحة عمل واحدة؛ account: كل المساحات التي ينتمي إليها كاتب المفتاح
القيم المسموحة: workspaceaccount
workspacesobject[]مطلوب
حيث يتصرف الرمز الآن
عرض الخصائص الفرعية
- idstringمطلوب
  معرّف مساحة العمل
- namestringمطلوب
  تُسمّى باسم منشآتها النشطة
scopesstring[]مطلوب
الصلاحيات التي يحملها الرمز
modestringمطلوب
test أو live
القيم المسموحة: testlive
expiresAtstring<date-time>
وقت انتهاء الرمز؛ يغيب لمفتاح بلا انتهاء

هل كانت هذه الصفحة مفيدة؟