| Metoda | Przeznaczenie |
|---|---|
| Autoryzacja | Wykonuje uwierzytelnienie użytkownika i zwraca token do autoryzacji zapytań API. |
| Żądanie generowania danych | Uruchamia zadanie generowania danych. Obsługuje parametry opcjonalne oraz pozwala uzyskać dane w formacie JSON lub CSV. System przetwarza żądanie asynchronicznie i zwraca identyfikator zadania (job ID). |
| Pobranie statusu zadania | Sprawdza bieżący status wcześniej wysłanego zadania generowania danych. Zwraca kod statusu oraz dodatkowe informacje (np. liczbę pakietów dla JSON). |
| Pobranie wyników zadania | Zwraca wyniki zakończonego zadania. Format zależy od formatu wskazanego w pierwotnym żądaniu. |
| api_get_users | Pobiera listę wszystkich użytkowników Proxima CRM. Możliwa filtracja po ID użytkowników. |
| api_get_company | Zwraca listę odwiedzonych instytucji (firm). Bez ograniczeń czasowych. |
| api_get_contact | Zwraca listę odwiedzonych klientów (kontaktów). Brak ograniczeń czasowych. |
| api_get_tasks | Pobiera informacje o wizytach dla podanego okresu. Obsługuje filtrowanie po ID zadania i ID użytkownika. |
| api_get_actions | Zwraca informacje o aktywnościach niewizytowych. Możliwa filtracja po ID. |
| api_get_entitymap | Zwraca mapowanie nazw pól z kart „Uzgodnienie” i „Kontrola” na kolumny systemowe w zależności od roli. |
| api_get_pdk | Zwraca informacje wprowadzone na karcie „Kontrola” podczas wizyty. |
| api_get_arrangement | Zwraca informacje wprowadzone podczas wizyty na karcie „Uzgodnienie”. |
| api_get_preparation | Zwraca informacje o markach i lekach załadowanych do systemu. |
| api_get_arrangement_json | Otrzymuje informacje wprowadzone podczas wizyty do karty „Ustalenia”. Zestaw uzupełnionych parametrów zależy od konfiguracji konkretnego klienta. Aby uzyskać tę konfigurację, należy użyć metody api_get_entitymap. |
| api_get_pdk_json | Otrzymuje informacje wprowadzone podczas wizyty do karty „Kontrola”. Zestaw uzupełnionych parametrów zależy od konfiguracji konkretnego klienta. Aby uzyskać tę konkretną konfigurację, należy użyć metody api_get_entitymap. |
| api_get_tasks_json | Otrzymuje informacje o wizytach za wskazany okres czasu. Obsługiwane jest filtrowanie według ID zadania oraz ID użytkownika. |
| api_get_actions_json | Zwraca informacje o aktywnościach niewizytowych (zadaniach) za wskazany okres. Obsługiwane jest filtrowanie według ID zadania oraz ID użytkownika. |
| api_get_users_json | Pobiera listę wszystkich użytkowników systemu Proxima CRM. W razie potrzeby listę można odfiltrować według określonych identyfikatorów użytkowników. |
| api_get_entitymap_json | Pobiera informacje o zgodności między nazwami pól widocznymi dla użytkownika w kartach „Ustalenia” i „Kontrola” a kolumnami systemowymi, w podziale na role użytkowników. |
| api_get_company_json | Zwraca listę instytucji (firm), które zostały odwiedzone co najmniej raz. Nie ma żadnych ograniczeń dotyczących okresu odwiedzin. |
| api_get_contact_json | Zwraca listę klientów (kontaktów), którzy zostali odwiedzeni co najmniej raz. Bez żadnych ograniczeń czasowych. |
| api_get_preparation_json | Pobiera informacje o markach i lekach, które zostały załadowane do systemu. |