Войти
Попробовать
>

API — документация для разработчиков

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

Контакт может быть автоматически одобрен и запланирован для отправки сообщений.

Это позволяет добавлять контакты через CRM или отправлять серию писем новым клиентам для получения обратной связи.
Базовый URL
Мы применяем HTTPS в каждом запросе, чтобы повысить безопасность, целостность и конфиденциальность данных.

Базовый адрес для всех запросов к API следующий:

https://app.respondo.ru/api
Аутентификация
Для аутентификации вам необходимо использовать HTTP-заголовок ApiKey, содержимое которого будет следующим: resp_xxxxxxxxx, где resp_xxxxxxxxx — это ваш API ключ . Получить API ключ можно в личном кабинете Respondo, в разделе Интеграции.
Формат передачи данных
  • Данные передаются в теле запроса как JSON-объект
  • В запросах необходимо передавать заголовок Content-Type: application/json
  • Аутентификация осуществляется с помощью заголовка ApiKey: resp_xxxxxxxxx
Ответы от сервера
HTTP-код 200 соответствует успешному выполнению запроса, коды 4xx — ошибкам, связанными с некорректным запросом, отсутствием запрашиваемого доступа для данного пользователя и прочее, а коды 5xx — ошибкам на сервере, произошедшим по независящим от пользователя причинам.

Возможные HTTP-коды ответов:
  • В случае успешного выполнения метода в ответ будет возвращен HTTP-код 200 (OK);
  • 400 (Bad Request) — неверно сформированный запрос, обычно эта ошибка; связана с опечатками в запросе, неверными идентификаторами и т.п.;
  • 401 (Unauthorized) — API-ключ неверный или не указан;
  • 404 (Not Found) — связанный ресурс не найден;
  • 409 (Conflict) — связанный ресурс уже существует;
  • 500 (Internal Server Error) — произошла ошибка на сервере Respondo по независящим от пользователя причинам.

Тело ответа:
В теле ответа может быть возвращено подробное пояснение произошедшей ошибки. Примеры ответов смотрите ниже.
Добавление контакта
POST: /add-contact
Данный метод добавляет контакт в вашу кампанию, а также осуществляет запуск рассылки для него, если передан специальный параметр. Кампания должна быть создана заранее в личном кабинете.

Метод требует указать ID кампании, который вы можете найти и скопировать в личном кабинете, во вкладке Настройки вашей кампании.

Параметры, которые принимает метод:
Примеры ответов:

Успешный ответ (200 OK)
json
{}
Кампания не найдена (404 Not Found)
json
{
    "error": "Кампания не найдена"
}
Примеры использования
Добавление контакта
cURL
curl -X POST "https://app.respondo.ru/api/add-contact" \
-H "Content-Type: application/json" \
-H "ApiKey: resp_xxxxxxxxx" \
-d '{
"campaignId": 1,
"emailAddress": "jane.smith@example.com",
"skipApproval": false,
"firstName": "Jane",
"lastName": "Smith",
"companyName": "Tech Solutions",
"site": "techsolutions.com",
"inn": "1234567890",
"phones": ["+7-999-123-45-67"],
"revenue": 5000000.5,
"employeesNumber": 25,
"customFields": {
"position": "CEO",
"industry": "Technology"
}
}