Получить токен доступа
/oauth
Возвращает токен доступа для авторизации запросов к API. Токен доступа действителен в течение 30 минут. Запросы на получение токена можно отправлять до 10 раз в секунду.
В заголовке Authorization нужно передать ключ авторизации — строку, полученную в результате кодирования в base64 идентификатора (Client ID) и клиентского ключа (Client Secret) API.
Консоль запросов автоматически кодирует заданные идентификатор и клиентский ключ.
Как получить ключ авторизации и токен доступа Access token читайте в разделах Быстрый старт для физических лиц и Быстрый старт для ИП и юридических лиц.
Запрос
Header Parameters
Возможные значения: Value must match regular expression (([0-9a-fA-F-])36)
Уникальный идентификатор запроса. Соответствует формату uuid4.
Параметр для журналирования входящих вызовов и разбора инцидентов. Идентификатор нужно указать самостоятельно, для этого можно использовать стандартные библиотеки и классы для генерации UUID и GUID.
Пример: 6f0b1291-c7f3-43c6-bb2e-9f3efb2dc98e.
- application/x-www-form-urlencoded
Body
GIGACHAT_API_PERS— доступ для физических лиц.GIGACHAT_API_B2B— доступ для ИП и юридических лиц по платным пакетам.GIGACHAT_API_CORP— доступ для ИП и юридических лиц по схеме pay-as-you-go.
Возможные значения: [GIGACHAT_API_PERS, GIGACHAT_API_B2B, GIGACHAT_API_CORP]
Версия API. Возможные значения:
OK
- application/json
- Схема
- Пример из схемы
Schema
Токен для авторизации запросов.
Дата и время истечения действия токена в формате unix timestamp.
{
"access_token": "eyJhbGci3iJkaXIiLCJlbmMiOiJBMTI4R0NNIiwidHlwIjoiSldUIn0..Dx7iF7cCxL8SSTKx.Uu9bPK3tPe_crdhOJqU3fmgJo_Ffvt4UsbTG6Nn0CHghuZgA4mD9qiUiSVC--okoGFkjO77W.vjYrk3T7vGM6SoxytPkDJw",
"expires_at": 1679471442
}
400 Bad request.
Некорректный формат запроса.
Ошибка авторизации.
- application/json
- Схема
- Пример из схемы
Schema
Код ошибки.
Описание ошибки.
{
"code": 6,
"message": "credentials doesn't match db data"
}