Документация по API вебхуков

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

Конструктор запроса

URL вебхука

Метод запроса

Параметры

Количество ({count})

ID заказа ({orderId})

ID пользователя ({userId})

Метка времени ({timestamp})

Результат

https://api.example.com/generate

Формат ответа

Ваш вебхук может возвращать ответ в одном из следующих форматов JSON:

Стандартный формат

{
  "success": true,
  "message": "Keys generated successfully",
  "keys": [
    "KEY-XXXXX-XXXXX",
    "KEY-XXXXX-XXXXX"
  ]
}

Альтернативный формат с "key"

{
  "success": true,
  "message": "Keys generated successfully",
  "key": [
    "KEY-XXXXX-XXXXX",
    "KEY-XXXXX-XXXXX"
  ]
}

Упрощенный формат без сообщения

{
  "success": true,
  "keys": [
    "KEY-XXXXX-XXXXX",
    "KEY-XXXXX-XXXXX"
  ]
}

Формат с кодом статуса

{
  "status": "success",
  "message": "Keys generated successfully",
  "keys": [
    "KEY-XXXXX-XXXXX",
    "KEY-XXXXX-XXXXX"
  ]
}

Примеры ответов с ошибкой

{
  "success": false,
  "message": "Failed to generate keys: insufficient stock",
  "keys": []
}

{
  "status": "error",
  "message": "Invalid request parameters"
}

{
  "success": false,
  "key": []
}

Требования к ответу

Статус ответа должен быть указан через поле success (boolean) или status (строка "success"/"error")
Сообщение (message) является опциональным
Массив ключей может быть указан в поле keys или key
В случае успешного ответа массив должен содержать хотя бы один ключ
В случае ошибки массив ключей может отсутствовать или быть пустым

Доступные переменные

Следующие переменные доступны для использования в URL и теле POST-запроса. Все переменные являются опциональными - используйте только те, которые необходимы для вашей логики:

{count}

Количество запрошенных ключей

{orderId}

Уникальный идентификатор заказа

{userId}

ID пользователя, совершающего покупку

{timestamp}

Текущая метка времени в формате ISO