Авторизация запросов

Авторизация запросов#

{% hint style=»info» %}

  • Для всех запросов требуется Basic-авторизация

  • Создаваемый ключ является кодированной в Base64 парой <key_id>:<password>

  • Для использования в Basic-авторизации вы можете декодировать его и использовать как пару логин:пароль, либо прописывать в заголовке как есть без дополнительного кодирования: Authorization: Basic {API_KEY} {% endhint %}

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

Во всех запросах авторизация происходит при помощи api-ключа. При этом ключи делятся на четыре типа:

  1. для работы с сообщениями (в описании методов –{TOKEN_1})

  2. для работы с системными сущностями (в описании методов –{TOKEN_2})

  3. для работы с API подтверждения телефона / виджетом подтверждения телефона для своего сайта (в описании методов – {TOKEN_3})

  4. для работы с виджетом подтверждения телефона для сайта на Tilda (в описании методов – {TOKEN_4})

Все типы ключей создаются в веб-интерфейсе личного кабинета Direct.

  • Перейдите в пункт меню «Разработчикам»

  • Нажмите «Создать ключ», укажите название, тип и центр разделения трафика (для методов работы с трафиком)

  • Нажмите «Создать», дождитесь результата

{% hint style=»warning» %} Обязательно скопируйте ключ, прежде чем закрывать окно: у вас больше не будет возможности его посмотреть. {% endhint %}

Действия с API-ключами#

После создания API-ключ можно деактивировать, перевыпустить и удалить.

  • При деактивации API-ключ перестает проходить авторизацию, на все запросы возвращается код HTTP 401. Ключ можно снова активировать в любой момент в боковом меню.

  • При перевыпуске старый ключ сразу перестает работать, вместо него вы получаете новый.

  • При удалении старый ключ сразу перестает работать.

Встраивание API во фронтенд#

Мы заботимся о вашей безопасности, поэтому API Direct предназначен исключительно для вызовов с защищенных серверов. При попытке выполнения API-запросов из браузера будет возникать CORS-ошибка, запрос OPTIONS для методов не доступен. Исключение из этого правила составляет только сервис Верификация телефона на Tilda.

Ограничения по IP#

По умолчанию доступ по API-ключу предоставляется из-под любых IP-адресов, но вы можете обратиться в поддержку и сообщить нам IP-адреса или подсети, которыми вы бы хотели ограничить доступ.

При включенном ограничении доступа при запросе, выполненном из-под неразрешенного IP-адреса, в ответе будет возвращаться ошибка HTTP 401 с телом:

{
    "error": {
        "code": 4013,
        "msg": "IP not allowed"
    }
}