Page tree
Skip to end of metadata
Go to start of metadata

Методы предназначены для управления подпиской на получение вебхуков на URL клиента.

Так как тестовый аккаунт СДЭК является общим для всех клиентов, для тестирования вебхуков необходимо использовать только боевой URL СДЭК.
В запросе на добавление подписки укажите свой тестовый URL, куда будут приходить вебхуки. После завершения тестирования поменяйте его на свой боевой URL.

1. Добавление подписки

Метод предназначен для добавления подписки на получение вебхуков. 
На текущий момент есть возможность добавить подписку на события по статусам заказа и по готовности печатной формы.

Запрос на добавление подписки

Для использования необходимо отправить POST-запрос на URL: https://api.cdek.ru/v2/webhooks

Тело запроса необходимо передавать в формате JSON (Content-Type: application/json).

Поддерживаются следующие поля:

Название поля

Описание

Тип поля

Обяз. для заполн.

1

urlURL, на который клиент хочет получать вебхукиstring()да
2type1Тип события:
ORDER_STATUS - событие по статусам
PRINT_FORM - готовность печатной формы
string()да

1 Если у клиента уже есть подписка с указанным типом, то старый url перезатирается на новый

Ответ на добавление подписки

Ответ возвращается в формате JSON:

Название поля

Описание

Тип поля

Обяз. для заполн.

1entityИнформация о подпискеentityнет
1.1uuidИдентификатор подписки в ИС СДЭКUUIDнет
2requestsИнформация о запросе над подпискойrequest[]да
2.1request_uuidИдентификатор запроса в ИС СДЭКUUIDнет
2.2typeТип запроса
Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET
string()да
2.3date_timeДата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
2.4state

Текущее состояние запроса
Может принимать значения: 

ACCEPTED - пройдена предварительная валидация и запрос принят
WAITING - запрос ожидает обработки (зависит от выполнения другого запроса)
SUCCESSFUL - запрос обработан успешно
INVALID - запрос обработался с ошибкой

string()да
2.5errorsОшибки, возникшие в ходе выполнения запросаerror[]нет
2.5.1codeКод ошибкиstring()да
2.5.2messageОписание ошибкиstring()да
2.6warningsПредупреждения, возникшие в ходе выполнения запросаwarning[]нет
2.6.1codeКод предупрежденияstring()да
2.6.2messageОписание предупрежденияstring()да


Пример запроса
{ 
	"url":"https://webhook.site",
	"type":"ORDER_STATUS"
}


Пример ответа
{
    "entity": {
        "uuid": "73c65d02-51a9-4423-8ee8-cc662ec3eb85"
    },
    "requests": [
        {
            "request_uuid": "72753031-0e1b-4f1d-abcc-b0bb0bd6ab2f",
            "type": "CREATE",
            "state": "SUCCESSFUL",
            "date_time": "2020-02-10T12:14:57+0700",
            "errors": [],
            "warnings": []
        }
    ]
}


2. Информация о подписке

Метод предназначен для получения информации о подписке/подписках клиента на получение вебхуков. 

Запрос на получение информации о подписке

Для использования необходимо отправить GET-запрос на URL: 

Ответ на получение информации о подписке

Ответ возвращается в формате JSON:

Название поля

Описание

Тип поля

Обяз. для заполн.

1entityИнформация о подпискеentityнет

1.1

uuidИдентификатор подпискиUUIDда
1.2urlURL, на который клиенту приходят вебхукиstring()да
1.3typeТип событияstring()да
2requestsИнформация о запросе над подпискойrequest[]да
2.1request_uuidИдентификатор запроса в ИС СДЭКUUIDнет
2.2typeТип запроса
Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET
string()да
2.3date_timeДата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
2.4state

Текущее состояние запроса
Может принимать значения: 

ACCEPTED - пройдена предварительная валидация и запрос принят
WAITING - запрос ожидает обработки (зависит от выполнения другого запроса)
SUCCESSFUL - запрос обработан успешно
INVALID - запрос обработался с ошибкой

string()да
2.5errorsОшибки, возникшие в ходе выполнения запросаerror[]нет
2.5.1codeКод ошибкиstring()да
2.5.2messageОписание ошибкиstring()да
2.6warningsПредупреждения, возникшие в ходе выполнения запросаwarning[]нет
2.6.1codeКод предупрежденияstring()да
2.6.2messageОписание предупрежденияstring()да
Пример запроса
https://api.cdek.ru/v2/webhooks/73c65d02-51a9-4423-8ee8-cc662ec3eb85


Пример ответа
{
    "entity": {
        "uuid": "73c65d02-51a9-4423-8ee8-cc662ec3eb85",
        "type": "ORDER_STATUS",
        "url": "https://webhook.site"
    },
    "requests": [
        {
            "request_uuid": "72753031-5ae3-448f-ba78-ea29d08e89fa",
            "type": "CREATE",
            "state": "SUCCESSFUL",
            "date_time": "2020-02-10T12:17:06+0700",
            "errors": [],
            "warnings": []
        }
    ]
}


3. Удаление подписки 

Метод предназначен для удаления подписки на получение вебхуков.

Запрос на удаление подписки

Для использования необходимо отправить DELETE-запрос на URL: 
https://api.cdek.ru/v2/webhooks/{uuid}, где uuid - идентификатор подписки

Ответ на удаление подписки

Ответ возвращается в формате JSON:

Название поля

Описание

Тип поля

Обяз. для заполн.

1entityИнформация о подпискеentityнет

1.1

uuidИдентификатор удаленной подпискиUUIDда
2requestsИнформация о запросе над подпискойrequest[]да
2.1request_uuidИдентификатор запроса в ИС СДЭКUUIDнет
2.2typeТип запроса
Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET
string()да
2.3date_timeДата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
2.4state

Текущее состояние запроса
Может принимать значения: 

ACCEPTED - пройдена предварительная валидация и запрос принят
WAITING - запрос ожидает обработки (зависит от выполнения другого запроса)
SUCCESSFUL - запрос обработан успешно
INVALID - запрос обработался с ошибкой

string()да
2.5errorsОшибки, возникшие в ходе выполнения запросаerror[]нет
2.5.1codeКод ошибкиstring()да
2.5.2messageОписание ошибкиstring()да
2.6warningsПредупреждения, возникшие в ходе выполнения запросаwarning[]нет
2.6.1codeКод предупрежденияstring()да
2.6.2messageОписание предупрежденияstring()да


Пример запроса
https://api.cdek.ru/v2/webhooks/73c65d02-51a9-4423-8ee8-cc662ec3eb85


Пример ответа
{
    "entity": {
        "uuid": "73c65d02-51a9-4423-8ee8-cc662ec3eb85"
    },
    "requests": [
        {
            "request_uuid": "72753031-0e1b-4f1d-abcc-b0bqw456ab2f",
            "type": "DELETE",
            "state": "SUCCESSFUL",
            "date_time": "2020-02-10T12:14:57+0700",
            "errors": [],
            "warnings": []
        }
    ]
}
  • No labels