Аутентификация
- Александр Яковлев
API FlexCard доступен только активированным пользователям FlexCard.
Аутентификация запросов к API осуществляется с использованием API-ключа.
Проверить работу API непосредственно с самой страницы описания операций API (кнопкой Try it out у любой операции) можно и без API-ключа – достаточно предварительно залогиниться на сайте FlexCard.
API-ключ представляет собой секретную строку, которую необходимо добавлять в каждый запрос к API FlexCard в HTTP-заголовке X-API-KEY.
Создать API-ключ можно в разделе API keys личного кабинета FlexCard.
При создании API-ключа необходимо указать его области действия (scopes). Области действия API-ключа должны соответствовать операциям API, с которыми планируется взаимодействовать. В документации к API в описании большинства операций перечислены необходимые области действия API-ключа (пример – на снимке экрана ниже). Если в описании операции нет списка областей действия, доступ к ней возможен с любым API-ключом.
Авторизация (проверка прав доступа) операций с API выполняется для пользователя – владельца API-ключа (т.е. c API не получится делать операции, не доступные самому владельцу API-ключа).
Количество API-ключей для каждого пользователя не ограничено. Рекомендуется создавать отдельный API-ключ с минимальными необходимыми областями действия для каждой задачи (сценария использования API). Например, для импорта списка карт в Google-таблицу из API /api/v1/cards/cards/ можно создать API-ключ с единственной областью видимости “FlexCard ⇾ Cards ⇾ View card”.
В случае необходимости действие API-ключа может быть ограничено периодом времени, “белым списком” IP-адресов клиента или прекращено совсем в личном кабинете FlexCard.