| Метод | Призначення |
|---|---|
| Авторизація | Виконує аутентифікацію користувача та повертає токен для авторизації АРІ-запитів. |
| Запит на формування даних | Запускає задачу генерації даних. Запит підтримує необов’язкові параметри та дозволяє отримати результати у форматі JSON або CSV. Система обробляє запит асинхронно та повертає ідентифікатор задачі (job ID) для відстеження. |
| Отримання статусу задачі формування даних | Перевіряє поточний статус раніше надісланої задачі на генерацію даних. Він повертає код статусу та додаткову інформацію про задачу, таку як кількість пакетів (для відповідей у форматі JSON). |
| Отримання результату завдання з генерації даних | Отримує результат раніше завершеного завдання з генерації даних. Формат відповіді залежить від формату, вказаного при первинному запиті завдання (csv або json). |
| api_get_users | Отримує список усіх користувачів системи Proxima CRM. За бажанням список можна відфільтрувати за конкретними ідентифікаторами користувачів. |
| api_get_company | Повертає перелік установ (компаній), які були відвідані хоча б один раз. Обмежень щодо періоду відвідувань немає. |
| api_get_contact | Повертає список клієнтів (контактів), які були відвідані хоча б один раз. Без обмеження за часом. |
| api_get_tasks | Отримує інформацію про візити за вказаний період часу. Підтримується фільтрація за по ID задач та ID користувача. |
| api_get_actions | Повертає інформацію про невізитну активність (завдання) за вказаний період. Підтримується фільтрація за ID завдань та ID користувача. |
| api_get_entitymap | Отримує інформацію про відповідність назв полів, які бачить користувач у картках “Домовленість” і “Контроль”, системним колонкам у розрізі ролей користувачів. |
| api_get_pdk | Отримує інформацію, яку вносять під час візиту в картку “Контроль”. Набір заповнених параметрів залежить від налаштувань конкретного клієнта. Для отримання конкретних налаштувань використовується метод api_get_entitymap.
|
| api_get_arrangement | Отримує інформацію, яку вносять під час візиту в картку “Домовленість”. Набір заповнених параметрів залежить від налаштувань у конкретного клієнта. Для отримання конкретних налаштувань використовується метод api_get_entitymap. |
| api_get_preparation | Отримує інформацію по брендам та лікам, які були завантажені до системи |
| api_get_arrangement_json | Отримує інформацію, яку вносять під час візиту в картку “Домовленість”. Набір заповнених параметрів залежить від налаштувань у конкретного клієнта. Для отримання конкретних налаштувань використовується метод api_get_entitymap. |
| api_get_pdk_json | Отримує інформацію, яку вносять під час візиту в картку “Контроль”. Набір заповнених параметрів залежить від налаштувань конкретного клієнта. Для отримання конкретних налаштувань використовується метод api_get_entitymap.
|
| api_get_tasks_json | Отримує інформацію про візити за вказаний період часу. Підтримується фільтрація за по ID задач та ID користувача. |
| api_get_actions_json | Повертає інформацію про невізитну активність (завдання) за вказаний період. Підтримується фільтрація за ID завдань та ID користувача. |
| api_get_users_json | Отримує список усіх користувачів системи Proxima CRM. За бажанням список можна відфільтрувати за конкретними ідентифікаторами користувачів. |
| api_get_entitymap_json | Отримує інформацію про відповідність назв полів, які бачить користувач у картках “Домовленість” і “Контроль”, системним колонкам у розрізі ролей користувачів. |
| api_get_company_json | Повертає перелік установ (компаній), які були відвідані хоча б один раз. Обмежень щодо періоду відвідувань немає. |
| api_get_contact_json | Повертає список клієнтів (контактів), які були відвідані хоча б один раз. Без обмеження за часом. |
| api_get_preparation_json | Отримує інформацію по брендам та лікам, які були завантажені до системи |