Содержание статьи
Корректный репорт должен содержать следующую информацию:
- информация о запросе,
- информация об ответе,
- суть проблемы.
Подробнее о содержимом каждого раздела ниже.
Информация о запросе:
1. Эндпоинт (URL):На какой адрес отправлялся запрос?
Примеры: https://api-b2b.lamoda.ru/api/v1/shipments/fulfilment
общий запрос: curl -v -k -X POST {полный запрос}
2. Метод запроса:
ET, POST, PUT, DELETE и т. д.
3. Передаваемые заголовки (Headers):
Пример:
{
"Content-Type": "application/json",
"Authorization": "Bearer {token}",
"X-Client-ID": "12345"
}
4. Тело запроса (Body):
Пример для POST:
{
"order_id": "123456",
"items": [{"sku": "ABC123", "quantity": 2}]
}
Информация об ответе:
1. Код ответа, полученный от Lamoda (HTTP Status Code):Например: 200 OK, 401 Unauthorized, 500 Internal Server Error
2. Заголовки ответа (Response Headers):
Пример:
{
"Content-Type": "application/json",
"X-Rate": "2024-03-15T12:00:00Z"
} 3. Тело ответа (Response Body):
Пример:
{
"status": "error",
"message": "Invalid API key"
}
Суть проблемы:
Отправил корректный запрос, получил ошибку:- Некорректный код ответа
- Некорректная структура ответа
- Содержимое ответа не соответствует документации
- Через какое время приходит ошибка? (Пример: "Через 1 минуту получаю таймаут")
- Воспроизведена ли проблема с другой машины? Если нет, необходимо воспроизвести самостоятельно с рабочего компьютера с отключенным VPN.
Помогла эта информация?
Спасибо за отзыв
