Аутентификация
Аутентификация по API-ключу и ограничения частоты запросов
Аутентификация
Все запросы к API Umbrella требуют аутентификации. В зависимости от эндпоинта используется один из двух способов.
Аутентификация через заголовки Shopify
Публичные эндпоинты (данные виджетов, заявки, поиск полисов) проходят аутентификацию по заголовкам с доменом магазина Shopify:
X-Shopify-Shop-Domain: your-store.myshopify.com
X-Shopify-Customer-Id: 1234567890При установке приложения Umbrella для Shopify домен вашего магазина регистрируется автоматически. Для эндпоинтов витрины ничего настраивать вручную не нужно.
Аутентификация по внутреннему API-ключу
Серверные эндпоинты (оценка применимости, синхронизация товаров) проходят аутентификацию по API-ключу в теле запроса:
{
"internalApiKey": "your-internal-api-key",
"orgId": "your-org-id"
}Чтобы создать или сменить внутренний API-ключ:
- Перейдите в Панель управления > Настройки > Интеграции
- Найдите раздел «API-ключи»
- Нажмите Создать новый ключ или Сменить ключ
Смена ключа сразу делает предыдущий недействительным. Обновите все интеграции до смены ключа.
Тестовая и рабочая среды
| Среда | Домен магазина | Поведение |
|---|---|---|
| Тестовая | *.test, demo.myshopify.com, test.myshopify.com | Возвращает тестовые данные, реальных транзакций нет |
| Рабочая | Ваш настоящий домен *.myshopify.com | Реальные данные, реальные транзакции |
Запросы в тестовом режиме возвращают в ответах "testingMode": true и используют примерные данные гарантий.
Обработка ошибок
Распространённые коды ошибок для всех эндпоинтов:
| Статус | Значение |
|---|---|
400 | Отсутствуют или неверны параметры |
401 | Не переданы учётные данные |
403 | Неразрешённый источник или неверный API-ключ |
404 | Ресурс не найден |
408 | Тайм-аут запроса (лимит 25 секунд) |
429 | Превышен лимит запросов — подождите и повторите |
500 | Внутренняя ошибка сервера |
Получив ответ 429, дождитесь окончания периода повтора, прежде чем отправлять новые запросы. При большом объёме запросов используйте экспоненциальную задержку между повторами.
См. также
- Обзор эндпоинтов — полный список доступных эндпоинтов
- API гарантий — эндпоинты для управления гарантийными планами
- Справочник по Webhook — интеграции на основе событий
