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

Введение ​

Добро пожаловать в документацию API Pocket Alert. В этом документе приведён общий обзор возможностей нашего API, который обеспечивает удобное взаимодействие с системой. Ниже представлена основная информация об аутентификации, которая является обязательным шагом перед любыми запросами к API.

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

Наш API поддерживает два типа аутентификации, чтобы подойти разным сценариям использования и предпочтениям:

1. Аутентификация по JWT-токену ​

Вы можете получить JWT (JSON Web Token) через метод аутентификации API.

Чтобы начать работу с аутентификацией по JWT-токену, отправьте запрос к эндпоинту авторизации, как показано в следующих разделах этой документации.

2. Готовые токены ​

Также вы можете использовать готовые токены для аутентификации. Такие токены создаются и управляются в разделе API-ключи вашего аккаунта. Этот способ позволяет получить доступ к API без дополнительного шага авторизации.

Переходите к следующим разделам, чтобы подробнее изучить API: описание эндпоинтов, примеры запросов и ответов, коды статусов, сообщения об ошибках и многое другое. Путь к удобной интеграции с нашим сервисом начинается здесь!

Важное примечание ​

При отправке запросов к API обязательно добавляйте необходимые заголовки.

Можно использовать любой из типов авторизации, но мы рекомендуем токены: так вы сможете разграничить доступ к своим данным для разных сервисов и приложений.

Перейти к руководству по быстрому старту ​

Документация Pocket Alert