Документация API v2.4

Интеграция Кортли для разработчиков

RESTful API позволяет синхронизировать отзывы, управлять ответами и получать аналитику напрямую из вашей PMS или CRM системы. Простые методы, понятные ответы.

Пример кода интеграции API Кортли на экране монитора

Введение в API

Наши API построены на принципах REST. Мы используем стандартные HTTP-методы и форматы кодов состояния. Все данные передаются в формате JSON.

Базовый URL

Все запросы отправляются на адрес https://api.kortli.ru/v2. Убедитесь, что используете протокол HTTPS.

Формат данных

Мы принимаем и возвращаем данные в формате JSON. Используйте заголовок Content-Type: application/json.

Ограничения

Лимит запросов: 100 запросов в минуту для тарифа "Старт", 1000 запросов в минуту для тарифа "Бизнес".

Аутентификация

Для доступа к API необходимо использовать API-ключ, который можно сгенерировать в личном кабинете в разделе "Настройки -> Интеграции". Передавайте ключ в заголовке Authorization.

# Пример заголовка запроса

Authorization: Bearer sk_live_51Mz8k2eZvKYlo2C0...

Безопасность ключей

Никогда не публикуйте свои секретные ключи в открытом доступе (например, в клиентском JS коде). Используйте их только на стороне сервера.

Основные эндпоинты

Управляйте отзывами и бизнес-профилями с помощью следующих методов.

GET /v2/reviews

Получение списка отзывов. Поддерживает пагинацию и фильтрацию по дате и источнику (Яндекс, Google, 2ГИС).

POST /v2/replies

Публикация ответа на отзыв. Требует ID отзыва и текст ответа. Автоматически отправляет уведомление клиенту.

GET /v2/analytics/summary

Сводка по репутации. Возвращает средний балл, количество отзывов за период и динамику изменений.

Примеры кода

Мы подготовили примеры для самых популярных языков программирования, чтобы вы могли начать интеграцию за 5 минут.

Python

import requests

url = "https://api.kortli.ru/v2/reviews"
headers = {
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
reviews = response.json()

for review in reviews['data']:
    print(f"{review['author']}: {review['text']}")

cURL

curl -X GET "https://api.kortli.ru/v2/reviews" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json"

Коды ответов (Status Codes)

API использует стандартные HTTP-коды для индикации успешности или ошибки запроса.

200 OK

Запрос выполнен успешно. Данные возвращены в теле ответа.

400 Bad Request

Ошибка в запросе. Проверьте формат JSON или обязательные поля.

401 Unauthorized

Отсутствует или неверен API-ключ. Проверьте заголовок Authorization.

429 Too Many Requests

Превышен лимит запросов в минуту. Попробуйте повторить запрос позже.

Нужна помощь с интеграцией?

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

Написать в техподдержку