Аутентификация в API FlipLink

Начало работы

Каждый запрос к API FlipLink аутентифицируется вашим API-ключом. Передавайте его в заголовке X-Api-Key или как Bearer-токен и подтверждайте, какому аккаунту он принадлежит, через Who Am I.

API, используемые в этом обсуждении

GETWho Am I/api/whoami

Что-то в этом руководстве неточно или устарело?

Что можно сделать

Каждый вызов API FlipLink привязан к аккаунту через его API-ключ. Это руководство описывает, как передавать этот ключ в запросе и как подтвердить, какому аккаунту принадлежит ключ.

Базовый URL

Все запросы к API идут на:

https://go.fliplink.me

Отправка API-ключа

Аутентифицировать запрос можно одним из двух способов — оба принимаются:

Заголовок X-Api-Key:

curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'X-Api-Key: YOUR_API_KEY'

Заголовок Authorization: Bearer:

curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Используйте тот, что удобнее вашему HTTP-клиенту. В остальных руководствах для единообразия используется X-Api-Key.

Подтверждение, какому аккаунту принадлежит ключ

GET /api/whoami возвращает аккаунт, которому принадлежит ключ, — это удобно, чтобы проверить, что ключ работает, и увидеть максимальный размер загрузки в вашем тарифе.

curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

MaxFileSizeMB — максимальный размер загрузки в вашем тарифе в мегабайтах.

Когда аутентификация не проходит

Если ключ отсутствует или недействителен, API отвечает HTTP 401 и возвращает обычную HTML-страницу Unauthorized — тела JSON нет. Проверьте, что ключ указан верно и передан в одном из двух заголовков выше.

Храните ключ в тайне

Ваш API-ключ идентифицирует ваш аккаунт — отправляйте его только из серверного кода. Никогда не встраивайте его в клиентский код или код браузера, где его смогут прочитать посетители.