Начало работы
Аутентификация
Текущая документация использует простую модель API key. Получите ключ в личном кабинете и передавайте его в каждом запросе к общему API base URL.
Текущий контракт
- API key выдаётся в личном кабинете.
Каждый запрос должен содержать заголовок
X-API-Key.Точное имя заголовка пока зафиксировано как документационный placeholder и при необходимости меняется централизованно через shared docs runtime config.
Первый аутентифицированный запрос
Для первой проверки используйте неразрушающий endpoint. Обычно лучший сигнал того, что base URL, заголовок и формат ключа корректны — это список проектов.
curl --request GET \
--url 'https://client-api.dc.dev.k8s.zenno.services/projects' \
--header 'X-API-Key: <api-key>' \
--header 'Accept: application/json'
Практические замечания
- Не храните API key в исходном коде и передавайте его в рантайме.
- Используйте один и тот же base URL во всех request builder вашего клиента.
- После подтверждения backend-командой обновите header contract и пересоберите документацию.
Типичные проблемы
Отсутствующий или некорректный auth header на раннем этапе интеграции часто выглядит так же, как и неправильный base URL. Проверяйте оба параметра одновременно, прежде чем искать ошибку в payload.