LogoAPI Documentation

2. Clients — клиенты агентства.


2.1 Index — список клиентов.

Ответ

{
  "clients": {
    "<ID_КЛИЕНТА>": {
      "client_id": <ID_КЛИЕНТА>,
      "email": "hello@world.com",
      "company_name": "The Client",
      "objects_count": 1,
      "calls_count": 10,
      "hidden_fields": [
        "utm",
        "call_page"
      ]
    },
    ...
  },
  "offset": 0,
  "limit": 20,
  "count": 20,
  "total": 201
}

2.2 Show — информация об одном клиенте.

200 OK

{
  "client": {
    "client_id": ID_КЛИЕНТА,
    "email": "hello@world.com",
    "company_name": "The Client",
    "objects_count": 1,
    "calls_count": 10,
    "hidden_fields": [
      "utm",
      "call_page"
    ]
  }
}

2.3 Create — создание клиента.

Тело запроса

{
  "client": {
    "email": "theclient@theagency.ru",
    "password": "verystrongpassword",             
    "company_name": "The Client #0001",
    "statistics_only": true,
    "hidden_fields": ["referrer", "utm"]
  }
}

Ответ

{
  "client_id": ID_КЛИЕНТА
}

2.4 Update — редактирование клиента.

Тело запроса

{
  "client": {
    "email": "newemail@theagency.ru",
    "password": "newverystrongpassword",             
    "company_name": "New company name",
    "statistics_only": false,
    "hidden_fields": null
  }
}

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

2.5 Delete — удаление клиента.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

2.6 Unbind — открепление клиента от агентства.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

2.7 Hidden fields — список скрытых полей, доступных к назначению.

Ответ

{
  "hidden_fields": {
    "call_page": "Страница звонка",
    "custom_data": "Свои данные",
    "duration": "Длительность",
    "ga_client_id": "GA Client ID",
    "phone_number_from": "От кого",
    "record_file": "Запись",
    "referrer": "Реферрер",
    "search_request": "Поисковый запрос",
    "source": "Источник",
    "status": "Статус",
    "url_parameters": "URL параметры",
    "utm": "UTM"
  }
}

2.8 Transactions — список транзакций клиента.

Ответ

{
  "transactions": [
    {
      "id": <ID_ТРАНЗАКЦИИ>,
      "object_id": "<ID_ОБЪЕКТА>",
      "date": "16.08.2014 21:54:44",
      "amount": "$600.00",
      "balance": "-$2,606.00",
      "way": "-",
      "type": "renew",
      "client_id": 1321
    },
    ...
  ],
  "offset": 0,
  "limit": 20,
  "count": 20,
  "total": 100
}