| Método | Finalidade |
|---|---|
| Autorização | Realiza a autenticação do usuário e retorna um token para autorizar solicitações da API. |
| Solicitação de geração de dados | Inicia a tarefa de geração de dados. A solicitação suporta parâmetros opcionais e permite obter resultados em formato JSON ou CSV. O sistema processa a solicitação de forma assíncrona e retorna um identificador de tarefa (job ID) para acompanhamento. |
| Obter status da tarefa de geração de dados | Verifica o status atual da tarefa anteriormente enviada. Retorna o código de status e informações adicionais, como a quantidade de pacotes (para respostas no formato JSON). |
| Obter resultado da tarefa de geração de dados | Obtém o resultado de uma tarefa já concluída. O formato da resposta depende do formato selecionado na solicitação original (csv ou json). |
| api_get_users | Obtém a lista de todos os usuários do sistema Proxima CRM. A lista pode ser filtrada por IDs específicos. |
| api_get_company | Retorna a lista de instituições (empresas) que foram visitadas pelo menos uma vez. Não há limitações de período. |
| api_get_contact | Retorna a lista de clientes (contatos) que foram visitados pelo menos uma vez. Sem limite de tempo. |
| api_get_tasks | Obtém informações sobre visitas em um período especificado. Suporta filtragem por ID de tarefa e ID de usuário. |
| api_get_actions | Retorna informações sobre atividades não relacionadas a visitas no período especificado. Suporta filtragem por IDs de atividades e IDs de usuário. |
| api_get_entitymap | Obtém informações sobre a correspondência entre os nomes dos campos nas telas “Acordo” e “Controle” e as colunas internas do sistema, considerando o papel do usuário. |
| api_get_pdk | Obtém informações inseridas durante a visita na tela “Controle”. O conjunto de parâmetros depende das configurações de cada cliente. Para obter configurações específicas, utilize o método api_get_entitymap. |
| api_get_arrangement | Obtém informações inseridas durante a visita na tela “Acordo”. O conjunto de parâmetros depende das configurações do cliente. Para detalhes, utilize api_get_entitymap. |
| api_get_preparation | Obtém informações sobre marcas e medicamentos carregados no sistema. |
| api_get_arrangement_json | Recebe as informações inseridas durante a visita no cartão “Acordo”. O conjunto de parâmetros preenchidos depende das configurações do cliente específico. Para obter as configurações específicas, utilize o método api_get_entitymap. |
| api_get_pdk_json | Recebe as informações inseridas durante a visita no cartão “Controle”. O conjunto de parâmetros preenchidos depende das configurações do cliente específico. Para obter essas configurações específicas, utilize o método api_get_entitymap. |
| api_get_tasks_json | Recebe informações sobre as visitas para o período de tempo especificado. É possível filtrar pelos IDs das tarefas e pelo ID do usuário. |
| api_get_actions_json | Retorna informações sobre atividades não relacionadas a visitas (tarefas) para o período especificado. É possível filtrar pelos IDs das tarefas e pelo ID do usuário. |
| api_get_users_json | Obtém a lista de todos os usuários do sistema Proxima CRM. Se necessário, a lista pode ser filtrada por identificadores específicos de usuários. |
| api_get_entitymap_json | Obtém informações sobre a correspondência entre os nomes dos campos que o usuário vê nos cartões “Acordo” e “Controle” e as colunas do sistema, considerando os papéis dos usuários. |
| api_get_company_json | Retorna a lista de instituições (empresas) que foram visitadas pelo menos uma vez. Não há restrições quanto ao período das visitas. |
| api_get_contact_json | Retorna a lista de clientes (contatos) que foram visitados pelo menos uma vez. Sem qualquer restrição de período. |
| api_get_preparation_json | Obtém informações sobre as marcas e medicamentos que foram carregados no sistema. |