#Ключи
Без ключа API не отвечает ничего, кроме отказа. Ключи заводятся в панели.
Настройки → Ключи API.
#Завести ключ
Впишите в поле «Кому выдаём», кто будет ходить этим ключом, и нажмите «Завести ключ»: «обмен с 1С», «мобильное приложение», «подрядчик».
Ключ показывается один раз — сразу после создания.
В базе сайта хранится только его отпечаток, самого ключа там нет. Потеряли — заведите новый и отзовите прежний. Это дешевле, чем хранить ключи в открытом виде: укравший базу не получит доступа к API.
Назвать ключ обязательно. Безымянные ключи через полгода не отличить друг от друга, и отзывать их приходится наугад.
#Как передавать ключ
Двумя способами, оба равноправны:
Authorization: Bearer 3f8c…
X-Api-Key: 3f8c…В адресе ключ не принимается — намеренно.
Адреса оседают в журналах веб-сервера, в истории браузера и в чужих реферерах. Ключ, переданный параметром, утекает туда, куда никто не смотрел.
#Что видно про ключ
| Столбец | Что показывает |
|---|---|
| Название | то, что вы задали |
| Заведён | дата создания |
| Последний раз | когда ключом пользовались |
Отметка о последнем визите обновляется при каждом удачном запросе. «Ни разу» — ключом ещё не пользовались.
Отозванный ключ помечен в списке припиской «— отозван» и показан бледным: кнопки отзыва у него уже нет.
#Отозвать ключ
Кнопка «Отозвать» рядом с ключом. Отзыв срабатывает сразу:
следующий запрос с этим ключом получит 401.
Внизу раздела — «Как обращаться»: готовые команды curl с адресом
именно вашего сайта, их можно скопировать и подставить свой ключ.
Отозванный ключ не удаляется из списка — видно, что он был и когда им пользовались в последний раз. Вернуть его нельзя, заведите новый.
#Сколько ключей заводить
По одному на каждую программу, которая ходит в сайт. Тогда отзыв одного не ломает остальные, а по отметке «последний раз» видно, кто ещё жив.
#Что чаще всего идёт не так
«401, хотя ключ верный». Проверьте заголовок: слово Bearer,
пробел, ключ. Частая ошибка — прислать Authorization: 3f8c… без
Bearer.
«Нет шаблона страницы». Так отвечает ядро 1.25.0 и старше: в тех выпусках шаблон раздела лежал не там, где его ищет панель. Лечится обновлением: Настройки → Обновление системы.
«Раздел „Ключи API“ пустой и ругается». Не накачена миграция, заводящая хранилище ключей. Обновите систему: Настройки → Обновление системы.
«Ключ работал и перестал». Посмотрите состояние в списке: скорее всего он отозван. Второй вариант — сайт выгружен на свой сервер, а ключи заводились после выгрузки.