Аккаунт

Кто я

Описывает токен вызова: тип, приложение, человека, от имени которого он действует, Workspace, разрешения, режим и срок. Читать может любой действительный токен.

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: один Workspace; account: все, где состоит автор ключа
Допустимые значения: workspaceaccount
workspacesobject[]обязательно
Где токен действует сейчас
Показать дочерние атрибуты
- idstringобязательно
  Идентификатор Workspace
- namestringобязательно
  Назван по его активным заведениям
scopesstring[]обязательно
Разрешения токена
modestringобязательно
test или live
Допустимые значения: testlive
expiresAtstring<date-time>
Когда токен истекает; нет у ключа без срока

Эта страница была полезной?