POST /webhook/register
Особенности:
- На один аккаунт может быть подписано несколько подписчиков.
- Имена подписчиков не повторяются в рамках одного аккаунта.
Параметры запроса
Заголовок | Описание |
|---|---|
X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, https://myaccount.ispring.ru. |
X-Auth-Email (обязательный) | Логин пользователя. |
X-Auth-Password (обязательный) | Пароль пользователя. |
Параметр | Описание |
subscriberName (обязательное) | Уникальное имя подписчика. Максимум 255 символов. |
callbackUrl (обязательное) | URL, на который будут отправляться события, на которые подписался подписчик. Максимум 255 символов. |
Secret (необязательное) | Подпись запроса HMAC. Максимум 255 символов. |
Пример запроса
curl --location 'https://api-learn.ispringlearn.ru/webhook/register' \
--header 'X-Auth-Account-Url: https://myaccount.ispring.ru' \
--header 'X-Auth-Email: email@email.com' \
--header 'X-Auth-Password: password' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"subscriberName": "name",
"callbackUrl": "https://client.service.com/callback-url",
"secret": "secret"
}'
Коды ответов
Код | Текст | Описание |
|---|---|---|
200 | ОК | Подписчик добавлен. |
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Ошибка авторизации. |
403 | Permission Denied | У пользователя нет прав на регистрацию подписчика. |