ДескусДескус · Документация
Все разделыСправочник · Аккаунт

GET /me — проверить ключ

Проверка подключения: работает ли ключ, от чьего имени и с какими правами. Подходит любой ключ или токен — отдельное право не нужно.

Запрос

curl https://app.deskus.ru/api/v1/me \
  -H "Authorization: Bearer $DESKUS_KEY"

Ответ 200 — ключ API

{
  "data": {
    "company": { "id": "6a0c4e8b-7d2f-4a1c-9e5b-8d3f2a7c0e19", "name": "Зерно" },
    "user": { "id": "d4e1b7a2-9c3f-4e6d-a5b8-0f2c7e9d1a35", "name": "Дарья Ветрова", "email": "daria@example.com" },
    "scopes": ["tickets:read", "tickets:write"],
    "credential": { "type": "api_key", "id": "8c4f2a6e-0b9d-4e1c-a7f3-2d5b8e1c9a46", "name": "Сайт" },
    "rate_limit": { "per_minute": 600 }
  }
}

credential у токена OAuth

"credential": { "type": "oauth", "app": { "id": "f2b6d0a8-1e4c-4b9d-8a7f-5c3e9b1d2a64", "name": "Коннектор" } }

Поле

Что в нём

company

Компания, к данным которой есть доступ

user

Сотрудник, от имени которого идут действия

scopes

Права ключа или подключения (список)

credential

Ключ (api_key, его id и название) или приложение (oauth)

rate_limit.per_minute

Лимит запросов в минуту

Ошибки: 401 — ключ не найден, отозван или истёк; 402 — лицензия компании закончилась (все коды).

Не нашли ответ? Напишите нам
Поддержка ответит в рабочее время.
Вы сотрудник «Дескус»?Изменить статью в Дескусе