Главная

Все обращения к API - это GET и POST HTTP запросы на домен Вашего аккаунта (кроме запросов к серверу авторизации) по URL /api/v1/

Для аутентификации каждого запроса необходимо передавать серверный API-ключ (параметр api_key), либо access token по механизму HTTP Basic authentication https://company.flowlu.ru/api/v1/module/crm/lead/list?api_key=dDhlTUtENmp4OFBGQkN0N2hUMUNUQ0FFeGI5N2JRZ0VfMQ

Описание параметров:
  • https://company.flowlu.ru/ - URL адрес вашего аккаунта, где вместо company должен быть указан ваш код аккаунта
  • /api/v1/ - адрес API и его версия (v1)
  • /module/crm/ - указывает на модуль (CRM, в данном примере)
  • /lead/ - указывает на сущность (Сделка, в данном примере)
  • /list - указывает на метод (Получение списка, в данном примере)
  • ?api_key=* - ваш персональный ключ доступа к API

Ответ на запрос будет возвращён в формате JSON с HTTP-кодом 200 Успешно выполненный запрос содержит объект response

{
  "response": {
    "total": 4,
    "page": 1,
    "count": 4,
    "items": [
      {
        "id": 1,
        "name": "Отправка счетов",
        "ordering": 1,
        "active": 1
      },
      {
        "id": 2,
        "name": "Отправка актов",
        "ordering": 2,
        "active": 1
      },
      {
        "id": 3,
        "name": "Работа по проектам",
        "ordering": 3,
        "active": 1
      },
      {
        "id": 4,
        "name": "Технические вопросы",
        "ordering": 4,
        "active": 1
      }
    ]
  }
}

При возникновении ошибки будет возвращен объект error, содержащий поле error_code, и, опционально, поля error_msg и error_details

{
  "error": {
    "error_code": 11,
    "error_msg": "authorization failed"
  }
}

Общие коды ошибок

10 unknown Неизвестная ошибка
11 authorization failed Авторизация не удалась. При авторизации по access_token необходимо получить новый. При авторизации по api_key необходимо проверить его правильность, и наличие в аккаунте
12 invalid request Ошибка запроса
13 internal server error Внутренняя ошибка сервера, рекомендуется повторить запрос позже
20 not found Объект, к которому идет обращение, не найден
21 validation error Ошибка при обработке отправленных данных. Список полей и возникшие проблемы описаны в массиве error_details
22 access denied Доступ запрещен
30 unknown method Неизвестный метод, либо данный метод не применим к данному объекту системы
31 unknown module
32 unknown model