| Әдіс | Мақсаты |
|---|---|
| Авторизация | Пайдаланушыны аутентификациялайды және API сұрауларын авторизациялау үшін токен қайтарады. |
| Деректерді генерациялау сұрауы | Деректерді генерациялау тапсырмасын іске қосады. Сұрау қосымша параметрлерді қолдайды және нәтижені 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_arrangement | Визит кезінде “Келісім” картасына енгізілетін ақпаратты қайтарады. |
| 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 | Жүйеге жүктелген брендтер мен дәрілер туралы ақпаратты алады. |