API externa
Integrar o TARGPatrol com outros sistemas pode expandir significativamente a funcionalidade da sua organização e melhorar a eficiência. Este guia mostrará como configurar a integração usando a API Externa do TARGPatrol.
Obter uma Chave de API
Acesse a aplicação webhttps://app.targpatrol.com/e faça login com sua conta.
Navegue até a"Gestão" -> "API Externa"seção (esta seção estará disponível apenas para usuários com o papel de Proprietário).
Clique no"Adicionar Token"botão.
Em seguida, clique em"Salvar", e o token aparecerá na tabela.
Em seguida, clique no ícone de copiar o token.
Documentação de API e Testes
Acesse a documentação de API emhttps://api.targpatrol.com.
Revise os endereços de API disponíveis e suas capacidades. Por exemplo, você pode encontrar endereços de API para criar tarefas, gerenciar usuários e muito mais.
Utilize as capacidades de teste diretamente na documentação, ou use ferramentas de terceiros como Postman para garantir que sua chave API funcione corretamente.
Dados do usuário
As solicitações e respostas do usuário usam o idioma para definir a língua e a formatação regional. Ao criar um usuário, forneça o nome completo, a localização e, pelo menos, uma localização. Os dados do usuário também podem incluir externalId e gpsTracking. Use uma das opções de idioma listadas no referencial da API.
Grupos de etapas de tarefas
As solicitações e respostas de tarefas suportam stepGroups. Cada grupo possui um ID, nome, descrição opcional, cor, ordem e configuração de desativação padrão. Uma etapa de tarefa faz referência ao grupo através de stepGroupId, enquanto a ordem da etapa permanece globalmente ao longo de toda a tarefa.
Referencie os esquemas e exemplos da API 1.1 para o conjunto completo de campos obrigatórios, valores suportados e formatos de solicitação.
Conclusão
Integrar o TARGPatrol com outros sistemas usando o API externa permite automatizar inúmeros processos e garantir uma gestão de tarefas mais eficiente.Siga este guia para configurar a integração e aproveitar todos os benefícios que ele oferece. Lembre-se de verificar regularmente o documento e as atualizações do API para obter as informações mais recentes.