API Hub — документация

Базовый адрес: https://api.jarvis-msk.ru/v1/. Все методы требуют API-ключ, который выдаёт администратор.

Авторизация

Ключ передаётся в заголовке Authorization: Bearer <ключ> (либо X-API-Key: <ключ>). Ключ имеет доступ только к разрешённым ему методам и лимит запросов в минуту: в ответах приходят заголовки X-RateLimit-Limit и X-RateLimit-Remaining, при превышении — 429 и Retry-After.

Каждый ответ содержит X-Request-Id — указывайте его при обращении в поддержку.

Ошибки

401 { "error": "unauthorized" }        — ключ отсутствует, отключён или истёк
403 { "error": "forbidden" }           — ключу не разрешён этот метод
404 { "error": "not_found" }           — метода нет
405 { "error": "method_not_allowed" }  — неверный HTTP-метод
429 { "error": "rate_limited" }        — превышен лимит
502 / 503 / 504                        — провайдер недоступен или не ответил вовремя

Пример

curl -X POST https://api.jarvis-msk.ru/v1/<метод> \
  -H "Authorization: Bearer hub_..." \
  -H "Content-Type: application/json" \
  -d '{ "param": "value" }'

Методы (2)

Tony Stark CRM

Получить данные по заказу

GET https://api.jarvis-msk.ru/v1/ts-crm-get-order
Метод возвращает данные по заказку из Tony Stark CRM

Таймаут: 30 с

Возвращает обновленные заказы из Тони

GET https://api.jarvis-msk.ru/v1/ts-crm-get-orders-by-queue

Таймаут: 30 с