Развезу

Тема

Аутентификация ​

Для работы с API Развезу требуется API ключ, который необходимо передавать в каждом запросе.

Получение API ключа ​

API ключ можно получить в личном кабинете Развезу. Обратитесь к администратору вашей компании для получения доступа.

Использование API ключа ​

API ключ передаётся в заголовке X-API-Key каждого HTTP запроса:

http
X-API-Key: ваш_api_ключ

Базовые URL ​

API доступен по следующим адресам:

bash
https://api.razvezu.pro/integration/v2
bash
https://test.api.razvezu.pro/integration/v2

Примеры запросов ​

bash
curl -X GET "https://api.razvezu.pro/integration/v2/depots" \
  -H "X-API-Key: ваш_api_ключ"
javascript
const response = await fetch('https://api.razvezu.pro/integration/v2/depots', {
  headers: {
    'X-API-Key': 'ваш_api_ключ'
  }
});

const data = await response.json();
console.log(data);
python
import requests

headers = {
    'X-API-Key': 'ваш_api_ключ'
}

response = requests.get(
    'https://api.razvezu.pro/integration/v2/depots',
    headers=headers
)

data = response.json()
print(data)

Ошибки аутентификации ​

При неверном или отсутствующем API ключе сервер вернёт ошибку:

json
{
  "ok": false,
  "errors": {
    "message": "Неверные данные аутентификации"
  }
}

HTTP статус: 401 Unauthorized

Безопасность ​

Важно

  • Никогда не публикуйте API ключ в публичных репозиториях
  • Храните ключ в переменных окружения или секретах
  • Не передавайте ключ через небезопасные каналы связи
  • При компрометации ключа немедленно запросите новый

Типы аутентификации ​

В API используются два типа аутентификации:

  • API Key (apikeyAuth) — для большинства эндпоинтов
  • Cookie (cookieAuth) — для некоторых специфических эндпоинтов (например, /destination)

Тип аутентификации указан в описании каждого эндпоинта.