Visão geral para programadores
A API de integração do exoCortex permite-te ligar as tuas aplicações à plataforma:
- a REST API v1 abre tickets, lê o seu estado e adiciona comentários;
- os webhooks de saída enviam aos teus sistemas os eventos dos tickets, assinados;
- os webhooks de entrada recebem alarmes e eventos de ferramentas de monitorização, de segurança e de outros ITSM;
- o SCIM 2.0 sincroniza utilizadores e grupos a partir do teu fornecedor de identidade;
- o widget recolhe pedidos a partir do teu site.
Por onde começar
Seção intitulada “Por onde começar”| Queres… | Lê |
|---|---|
| Abrir o primeiro ticket em cinco minutos | Primeiros passos |
| Usar um cliente pronto em JavaScript, Python ou bash | SDK e CLI |
| Ver parâmetros, respostas e exemplos de cada endpoint | Referência da API |
| Perceber o que pode mudar e quando | Versões e descontinuações |
| Configurar chaves, webhooks, widget ou SCIM a partir da consola | Guias de integração |
Em resumo
Seção intitulada “Em resumo”| Endereço | https://exocortex-api.ai-exo-cortex.com |
| Versão | /api/v1, especificação 1.1.0 |
| Formato | JSON, UTF-8 |
| Autenticação | Chave de API nhk.<keyid>.<secret> em Authorization: Bearer |
| Limites | 600 pedidos a cada 60 segundos por chave, salvo configuração diferente |
| Erros | ok: false com um code estável |
A referência é gerada a partir da especificação OpenAPI da API: as descrições e os exemplos estão em inglês, como na especificação.