API / INTEGRAÇÕES
O acervo visual da obra.
Dentro da sua operação.
Consulte câmeras, imagens por período e timelapses publicados pela API. Defina permissões, obras e limites para cada integração.
Conversar sobre integraçãocurl --request GET "$TIMELAPSE_BASE_URL/v1/cameras" --header "Authorization: Bearer $TIMELAPSE_API_KEY"cameras:read · lista as câmeras autorizadas para esta chave.
Exemplo de consulta para execução no seu servidor. Substitua as variáveis pelo ambiente contratado e por uma chave autorizada. Esta página não envia requisições à API nem solicita credenciais.
A informação certa.
No sistema que precisa dela.
Estruture uma integração para disponibilizar o registro visual em um portal, uma rotina interna ou um painel da empresa. O desenho e a implantação da integração são avaliados com sua equipe técnica.
Portal de acompanhamento.
Consulte a última imagem de câmeras autorizadas para atualizar uma experiência própria. Defina o público, o período de disponibilidade e a política de exposição antes de distribuir o conteúdo.
Rotinas de gestão.
Recupere imagens por intervalo e vídeos publicados para conectar os registros à rotina do projeto. A API usa JSON e paginação por cursor para organizar consultas sucessivas.
A disponibilidade da API não significa que exista um conector pronto para todo ERP, CRM ou ferramenta de BI. O escopo da integração, a frequência das consultas e a gestão dos arquivos precisam ser definidos no projeto técnico.
Recursos para
integrações objetivas.
O contrato público /v1 organiza consultas ao acervo. A documentação interativa e a especificação OpenAPI ficam disponíveis no ambiente da implantação.
| RECURSO / GET | APLICAÇÃO | ESCOPO |
|---|---|---|
/v1/cameras/v1/cameras/:id | Listagem e consulta das câmeras autorizadas. | cameras:read |
/v1/cameras/:id/latest | Registro mais recente da câmera. | images:read |
/v1/cameras/:id/images | Imagens por período e paginação.Parâmetros: from, to, cursor e limit. | images:read |
/v1/cameras/:id/timelapses | Timelapses publicados e disponíveis para a integração.Não oferece a versão UHD por esta rota. | timelapses:read |
/v1/cameras/:id/live | Sessão ao vivo, quando habilitada.Depende do recurso contratado, câmera e infraestrutura. | live:read |
/v1/projects/:id/weather | Informações de clima do projeto, quando habilitadas. | weather:read |
Uma chave.
Um escopo definido.
Controle cada integração por finalidade e necessidade. A chave deve refletir os acessos que a aplicação realmente precisa.
Permissões e obras.
Selecione os recursos autorizados e, quando aplicável, restrinja a chave às obras necessárias. O acesso da chave acompanha as permissões atuais de quem a criou.
Origem, IP e validade.
Configure restrições de origem e endereço IP conforme o tipo de integração. Defina validade e revogue a chave quando a finalidade terminar ou quando houver necessidade de substituição.
Limites de consumo.
A API aplica limites por minuto e cotas mensais para empresa e chave. Respostas 429 incluem indicação para nova tentativa; o cliente deve respeitar esse intervalo.
Operação rastreável.
Identificadores de requisição ajudam a relacionar uma consulta ao atendimento técnico. Consulta de uso e registro do último uso apoiam a administração das chaves.
Da intenção ao
contrato de integração.
A conversa começa pelo dado necessário e pelo destino. Depois vêm os acessos, a frequência e os critérios de validação.
- 01
Mapear a necessidade.
Qual sistema recebe o conteúdo? Quem poderá consultar? Qual intervalo de atualização faz sentido?
- 02
Definir acesso.
Escopos, obras, origem, IPs, validade e limites de consumo da chave.
- 03
Validar em ambiente.
Autenticação, formatos, paginação, erros, limites e comportamento após revogação.
- 04
Operar e acompanhar.
Monitoramento da aplicação, revisão de chaves e processo de suporte entre as equipes.
Documentação no ambiente: /v1/docs · especificação: /v1/openapi.json. URLs, habilitação, limites e condições comerciais são definidos na implantação.
Vamos conectar a evolução
à sua operação?
Traga o sistema de destino e a necessidade de informação. Vamos organizar a avaliação técnica da integração.
