Авторизация Web API

Большинство запросов к API требует авторизации, чтобы мы убедились, что вы имеете права на совершение операции, которую запрашиваете. Авторизация производится при помощи токена, который можно получить в панели администратора в разделе "Настройки > Разработчикам" -> "API-ключи".

Auth token

Важно! Токены дают практически неограниченный доступ к данным вашего приложения! Сохраняйте их в тайне и не передавайте третьим лицам во избежание утечек данных.

Важно! Поскольку API-ключ надо сохранять в тайне, нельзя использовать API запросы из браузера (JavaScript) кода. Для этого лучше воспользоваться нашей JavaScript библиотекой.

Как авторизовать запросы

Передача заголовка запроса Authorization (рекомендуется)

Вы можете передать токен авторизации в специальном заголовке Authorization. В содержимом заголовка должно быть Token {your_token} или Bearer {your_token}.

Примеры:

curl -X POST \
  --header "Authorization: Token XXX" \
  https://api.carrotquest.io/users/123

curl -X POST \
  --header "Authorization: Bearer XXX" \
  https://api.carrotquest.io/users/123

Передача параметра запроса auth_token

Вы можете передать токен авторизации в GET/POST параметре запроса auth_token.

Примеры:

curl -X POST -H "Authorization: Token XXX" https://api.carrotquest.io/users/123

curl -X GET  -H "Authorization: Token XXX" "https://api.carrotquest.io/users/123"