API externa
Conecte seus sistemas a uma organização pela API externa TARGPatrol. Este guia cobre acesso, autenticação e integração segura. Os campos e exemplos de cada operação ficam na referência da API.
Disponibilidade e chaves de API
A API externa está disponível em Base e Enterprise, não em Free. O Proprietário cria e gerencia tokens no aplicativo web. Cada chave identifica uma organização; não é uma senha pessoal nem um ID/PIN móvel.
Entre na web e abra a organização correta como Proprietário.
Abra Gestão → API externa e selecione Adicionar token.
Dê um nome claro à integração, salve o token e copie a chave.
Guarde-a em um cofre de segredos no servidor. Prefira tokens separados por integração e revogue os que não são mais necessários.
Autenticar solicitações
Envie solicitações HTTPS ao host indicado na referência com o caminho base /api/v1. Inclua a chave no cabeçalho x-api-key. Entrar no aplicativo web não autentica uma solicitação externa. Não coloque chaves em URLs, código do navegador, capturas, repositórios públicos ou logs.
1x-api-key: <YOUR_API_KEY>Usar a referência e testar com segurança
Na referência, confira método, caminho, campos obrigatórios e esquema de resposta da operação.
Comece com uma leitura e confirme a organização dos resultados. Testes interativos podem atuar em dados reais.
Siga a paginação, os filtros e a ordenação da operação; os padrões podem variar.
Antes de gravar, confira a semântica POST, PUT ou PATCH e o tratamento de valores omitidos, null ou vazios. Teste primeiro em uma organização de teste.
Trate erros de rede e servidor. Não repita solicitações de criação às cegas e não registre chaves nem dados pessoais.
Referência da API e explorador interativo
Resolver problemas de acesso
Em 401, confira x-api-key e se o token existe. Em 403, confira o plano e os requisitos da operação. Em 404, confira URL, identificador e organização; em 400, formato e validação. Troque uma chave exposta e atualize todas as integrações que a usam.
Novidades da referência da API
1.1
A referência 1.1 tornou lastName obrigatório ao criar usuários e corrigiu o nome do campo de atribuição de locais para locationIds. Consulte o esquema de usuário atual ao preparar solicitações.
1.2
A referência 1.2 adicionou URLs de download assinadas e temporárias para anexos do módulo antigo Issues, incluindo URLs de miniaturas quando disponíveis. Os links devem ser usados antes de expirarem.
1.3
A referência 1.3 adicionou listagem e criação de comentários para Tarefas, Incidentes e o módulo antigo Issues, além de edição e exclusão de comentários criados pela API. Os anexos existentes podem ser consultados e baixados; esta API não permite enviar anexos nem editar comentários criados por usuários do aplicativo.
1.4
A referência 1.4 adicionou metadados e validação de telefones internacionais de usuários. Consulte os esquemas atuais para as regras exatas de solicitações e atualizações.
1.5
A referência 1.5 adicionou histórico de alterações por registro, somente leitura. Atualizações posteriores documentam históricos de Usuários, Locais e Pontos, além da ordem dos pontos e operações para reordenar/mover. Consulte a referência atual para compatibilidade e operações disponíveis.
1.6
A referência 1.6 documenta tarefas recorrentes baseadas no calendário com fuso horário explícito e modelo local de início e fim salvo. Consulte o esquema atual antes de criar ou editar uma série.
1.7
A referência 1.7 adiciona a consulta de eventos de cerca virtual e campos relacionados de locais e usuários, e alinha as operações de tags compatíveis. A autenticação e /api/v1 não mudam. Consulte esquemas, permissões e validação na referência atual; esta atualização não inclui webhooks de cerca virtual.
São versões da referência/esquema, não novos prefixos de URL: o caminho base continua /api/v1. Este resumo não substitui um changelog completo. Webhooks são configurados separadamente para atualizações por eventos.