Быстрый старт

Coldy API использует Bearer API-ключ для определения вашей организации. За несколько минут вы можете создать ключ и получить список рассылок.

1. Создайте API-ключ

   Откройте Настройки → Интеграции, выберите API Keys и создайте ключ для нужной организации. Сразу скопируйте его: Coldy показывает полное значение только один раз.

2. Сохраните ключ безопасно

   Поместите ключ в менеджер секретов или защищённую серверную переменную окружения. В примерах используется COLDY_API_KEY.

   COLDY_API_KEY=YOUR_API_KEY

3. Получите список рассылок

   Передайте ключ как HTTP Bearer-токен.

   curl --request GET \
     --url https://developer.coldy.ai/api/v1/campaigns \
     --header "Authorization: Bearer $COLDY_API_KEY" \
     --header "Accept: application/json"

4. Используйте ответ

   Успешный запрос возвращает 200 OK и рассылки организации, связанной с ключом. Имена свойств ответа записаны в snake_case.

Следующие шаги

• Прочитайте раздел Аутентификация перед использованием ключей в продакшене.
• Изучите обработку ошибок и повторных запросов.
• Просмотрите сгенерированные страницы методов в разделе Ресурсы.

Идентификаторы и доступ

ID рассылок имеют формат UUID. ID аккаунтов, лидов, цепочек писем, тредов и писем могут быть последовательными числами. ID — это ссылки, а не учётные данные: сами по себе они не предоставляют доступ. В универсальных клиентах обрабатывайте ID как строки, если вам не нужна арифметика.