Аутентификация
Каждый запрос к потребительскому API сопровождается API-токеном. Токен выдается для инсталляции клиента и определяет, какие нексусы доступны и на чей расход относится запрос. Читайте подробнее в статье API-токены.
Передача токена
Передайте токен целиком в заголовке Authorization с префиксом Bearer:
curl https://<адрес инсталляции>/v1/models \
-H "Authorization: Bearer <токен>"
Других способов передать токен нет: ни параметром строки запроса, ни отдельным заголовком платформа его не принимает.
Префикс чувствителен к регистру. Значение bearer <токен> платформа не распознает и вернет ответ 401.
Роль токена – User или Admin – на доступ к потребительскому API не влияет. Роль ограничивает только операции с самими токенами.
Если токен не принят
Платформа отвечает до того, как запрос дойдет до нейросети. Тело ответа – объект с полями code и message:
{"code":401,"message":"invalid token"}
| Код | message | Причина | Что делать |
|---|---|---|---|
401 | missing Authorization header | Заголовок Authorization отсутствует или пуст. | Добавьте заголовок. |
401 | invalid token | Токен не найден, поврежден или отозван. | Запросите новый токен у администратора инсталляции. |
403 | token blocked | Токен заблокирован администратором или по исчерпанию квоты. Причина указана в записи токена. | Обратитесь к администратору инсталляции. |
500 | token service error | Сбой хранилища токенов. | Повторите запрос, при повторении ошибки обратитесь в поддержку. |
503 | {"code":503,"message":"..."} | Служба проверки токенов недоступна. | Повторите запрос позже. |
Ответы платформы на остальные ошибки собраны в статье Ошибки и лимиты.
Прекращение действия токена
Токен перестает работать в двух случаях: администратор его отозвал или наступила дата, указанная в поле Истекает записи токена.
Отзыв необратим: для возобновления работы выдается новый токен. Читайте подробнее в статье API-токены.