API

Saiba mais sobre os recursos da API do OpsIQ e referências do SDK

O API do OpsIQ suporta idempotência?
Sim, o modelo de desenvolvedor inclui proteção contra reprodução idempotente para gravações. Este recurso inclui uma janela de idempotência de 24 horas documentada para operações suportadas. Os clientes devem reutilizar…
2,882
Como os webhooks de saída do OpsIQ são assinados?
OpsIQ assina os payloads de webhook de saída usando HMAC-SHA256 sobre o corpo da solicitação bruta. Também inclui metadados de entrega, como o timestamp e o evento. Os receptores devem seguir estas etapas: Calcule a…
2,870
Quantas operações estão disponíveis através da API Geral do OpsIQ?
As páginas atuais de desenvolvedor e integrações descrevem 1.558 operações nomeadas da API Geral regidas por 62 escopos de menor privilégio. O registro de operações garante que o comportamento da API, a documentação de…
2,856
O API do OpsIQ suporta solicitações de dry-run?
Sim, a API do OpsIQ suporta solicitações de dry-run. As operações suportadas podem utilizar o comportamento dry_run, permitindo que os integradores validem a intenção e os parâmetros sem comprometer a gravação. Este…
2,817
Quais formatos de referência de SDK e API o OpsIQ fornece?
OpsIQ fornece uma descrição OpenAPI 3.0.3, recursos Postman e padrões auxiliares para PHP, Node.js e Python. Isso permite que as equipes integrem-se com sua pilha de tecnologia preferida em vez de depender de um único…
2,654
Posso desativar temporariamente um token de API sem excluí-lo?
Sim, os Tokens de API suportam desativar e depois reativar um token. Você pode desativar um token quando uma integração deve parar temporariamente de usá-lo. Por favor, lembre-se de que a integração conectada falhará na…
2,560
Como funciona a limitação de taxa da API no OpsIQ?
OpsIQ aplica limites de taxa da API por chave e retorna informações de limitação de taxa nos cabeçalhos de resposta. Quando um limite é excedido, os clientes recebem um código de status HTTP 429 junto com orientações…
2,540
Que informações posso ver sobre um token de API?
A página API Tokens fornece vários detalhes sobre cada token, incluindo: Nome do Token Identificador Público Permissões Concedidas Status Atual Informações de Uso (por exemplo, quando foi usado pela última vez) Observe…
2,483
Por que não posso ver meu segredo do token API novamente?
O segredo do token é mostrado intencionalmente apenas no momento da criação. A conta armazena o que precisa para verificar o uso futuro do token, em vez de uma cópia em texto claro reutilizável para exibição posterior…
2,461
Como faço para me autenticar na API Geral do OpsIQ?
Autenticando-se na API Geral do OpsIQ A API Geral do OpsIQ utiliza chaves de API Bearer com escopo. É importante que essas chaves sejam atribuídas apenas aos escopos de menor privilégio necessários para sua função. Além…
2,405
O que acontece quando eu excluo um token de API?
Excluir um token remove permanentemente esse token de cliente do uso ativo. Qualquer integração ainda configurada com ele parará de autenticar e deve ser atualizada com um novo token se o acesso ainda for necessário. Se…
2,392
O que são tokens de API de cliente no OpsIQ?
Tokens de API de cliente permitem que você autorize integrações com escopo de cliente suportadas sem compartilhar sua senha de conta. Esses tokens podem ter permissões limitadas para operações de conta, licença…
2,370
Como eu crio um token de API de cliente do OpsIQ?
Para criar um token de API de cliente do OpsIQ, siga estas etapas: Abra a seção de Tokens de API. Crie um token com um nome descritivo. Selecione as permissões disponíveis apropriadas. Após o token ser criado, copie o…
2,314
Posso usar um token da API OpsIQ em vez da minha senha de conta para uma integração?
Sim, você pode usar um token da API OpsIQ em vez da senha da sua conta para operações de API de cliente suportadas. Este método é preferível a fornecer uma integração com a senha interativa da sua conta porque o token…
1,951
Ainda precisa de ajuda?

Nossa equipe está aqui se você não conseguir encontrar o que está procurando.

Contatar suporte