Referencia de la APIReferência da API
Cloura ofrece una API REST para integrar tus hallazgos en tus propias herramientas (disponible desde el plan Scale). La referencia completa se publica con OpenAPI.
O Cloura oferece uma API REST para integrar seus achados em suas próprias ferramentas (disponível a partir do plano Scale). A referência completa é publicada com OpenAPI.
Para qué sirvePara que serve
Sirve para integrar los hallazgos priorizados de Cloura en tus flujos —tableros, tickets, data warehouse— sin entrar a la app. Es de solo lectura sobre tus resultados de análisis.
Serve para integrar os achados priorizados do Cloura nos seus fluxos —painéis, tickets, data warehouse— sem entrar no app. É de apenas leitura sobre seus resultados de análise.
Acceso y autenticaciónAcesso e autenticação
Es una API máquina-a-máquina (M2M). Desde Ajustes generas credenciales de cliente (client credentials) y obtienes un token para autenticar cada llamada. Trata esas credenciales como secretas.
É uma API máquina-a-máquina (M2M). Em Configurações você gera credenciais de cliente (client credentials) e obtém um token para autenticar cada chamada. Trate essas credenciais como secretas.
Disponibilidad por planDisponibilidade por plano
La API REST para integrar hallazgos está disponible desde el plan Scale; con capacidades ampliadas en Enterprise.
A API REST para integrar achados está disponível a partir do plano Scale; com capacidades ampliadas no Enterprise.
Especificación (OpenAPI)Especificação (OpenAPI)
La definición formal de rutas, parámetros y respuestas se entrega como documento OpenAPI desde tu cuenta (sección API en Ajustes). Úsala para generar clientes o explorar los endpoints.
A definição formal de rotas, parâmetros e respostas é entregue como documento OpenAPI a partir da sua conta (seção API em Configurações). Use-a para gerar clientes ou explorar os endpoints.
Buenas prácticasBoas práticas
- Pagina los resultados en lugar de pedirlos todos de una vez.
- Cachea las respuestas cuando puedas.
- Rota tus credenciales periódicamente.
- Pagine os resultados em vez de pedir todos de uma só vez.
- Faça cache das respostas quando possível.
- Rotacione suas credenciais periodicamente.