Перейти к содержимому

Аутентификация

Каждый запрос к API содержит API-ключ. Запросы никогда не привязываются к сессии браузера.

Создание API-ключа

Создавайте ключи в разделе API-ключи своего аккаунта, не более 5. Пока вы вошли в аккаунт, ключ можно скопировать на этой странице в любой момент: мы храним его в зашифрованном виде и показываем только вам. Храните его в тайне, как пароль, а если он мог быть раскрыт, отзовите его и создайте новый.

Передача API-ключа

Передавайте его в заголовке Authorization как Bearer и затем сам ключ. X-API-Key тоже работает.

curl "https://api.talismanleads.io/v1/account" \
  -H "Authorization: Bearer tl_live_your_key_here"

Что может API-ключ

Новый API-ключ может всё: видеть ваш баланс, проверки, ваши заказы и их результаты, а также использовать POST /uploads, POST /estimates и POST /orders, которые сохраняют ваш список или расходуют ваш баланс. Ключ, созданный до 8 ноября 2026 года, может быть только для чтения: он видит всё, но эти три вызова отклоняют его с кодом missing_scope.

Срок действия и IP-адреса

Срок действия нового API-ключа не истекает, и он работает с любого адреса. У ключа, созданного до 8 ноября 2026 года, может быть срок действия, после которого он отклоняется с кодом expired_key, или он может быть ограничен IP-адресами вашего сервера, так что запрос из любого другого места отклоняется с кодом ip_not_allowed. Чтобы изменить что-либо из этого, создайте новый ключ и отзовите старый.

Безопасность API-ключа

  • Относитесь к API-ключу как к паролю: любой, у кого он есть, может потратить ваш баланс.
  • Используйте его только на своём сервере. API не разрешает вызовы с веб-страницы.
  • Не храните его в коде и в системе контроля версий.
  • Если ключ мог быть раскрыт, немедленно отзовите его в своём аккаунте. Он сразу перестанет работать. Уже размещённые заказы продолжат выполняться.
  • Отправляйте его только в API. Ссылки для загрузки и скачивания имеют собственное разрешение, поэтому не отправляйте на них свой API-ключ.

Когда API-ключ отклонён

На неверный, отозванный или просроченный ключ приходит ответ 401. На заблокированный ключ или аккаунт приходит ответ 403. См. Ошибки.

На этой странице