Notify.Events API

Notify.Events API используется для того, чтобы интегрировать возможности сервиса уведомлений Notify.Events в личный проект клиента, и предназначен для разработчиков.

Описание

API сервиса Notify.Events работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON-структур.

Более подробную информацию об используемых в документации понятиях и сущностях (таких как Каналы, Источники, Получатели и пр.) и их взаимосвязи вы можете найти в нашем Центре Помощи, в разделе Знакомство с Notify.Events.

Ограничение на количество запросов - 10 запросов в секунду.

Кросдоменные запросы (например, jQuery Ajax) запрещены.

Основной URL

Все ссылки на запросы к API в этой документации включают обязательный основной URL:
https://notify.events/api/v1/

Авторизация

Авторизация на уровне API происходит при помощи Bearer-токена, который необходимо передавать в заголовке Authorization для каждого запроса:

Authorization: Bearer <Ваш ключ>

Ваш токен (Auth Key) вы найдете в настройках профиля, в секции API.

Коды и форматы ответов

200 – успешная обработка запроса. В этом случае сервер вернёт вам данные в формате JSON.

401 – отсутствие авторизации или некорректный авторизационный токен.

422 – некорректный запрос к API. В этом случае сервер так же выдаст информацию о том, какие поля вызвали ошибку валидации и по какой причине.

Пример ответа:

[
  {
    "field": "title",
    "message": "Title cannot be blank."
  },
  {
    "field": "group",
    "message": "Group must be a string."
  }
]