Documentação do Desenvolvedor

Encontre recursos para desenvolvedores e documentação da API

Navegar por categoria 5 subcategorias
50 artigos · Nesta seção
API do Desenvolvedor, Webhooks e Construtor de Conectores — OpsIQ
OpsIQ oferece uma plataforma robusta para construir integrações governadas através de sua API do Desenvolvedor, Webhooks e Construtor de Conectores. Isso permite que os desenvolvedores criem aplicações operáveis por IA…
3,105
Os Sites Remotos podem relatar conversões de vendas para OpsIQ?
Sim, Sites Remotos suportam padrões de ponte de conversão de vendas, permitindo que compras e outros resultados sejam atribuídos ao site e jornada corretos. Modelos são fornecidos para ambientes como WooCommerce e PHP…
3,000
Guia do administrador e desenvolvedor do Portal Studio — OpsIQ
Visão Geral O Portal Studio da OpsIQ permite que você construa, visualize, gerencie, publique e amplie um portal de clientes corporativos. Este guia fornece informações essenciais para administradores e desenvolvedores…
3,000
Quantas integrações e capacidades de conector o OpsIQ possui?
Capacidades de Integração e Conector do OpsIQ O atual plano de controle de integração relata o seguinte: 23 pacotes agrupados 21 entradas do marketplace 52 tipos de capacidade 7 perfis iniciais 1.558 Ações Gerais da API…
2,996
Quantos eventos de webhook de saída canônicos o OpsIQ possui?
Eventos de Webhook de Saída Canônicos no OpsIQ A página de Webhooks & Ações descreve um total de 30 eventos de saída canônicos, juntamente com a capacidade para assinaturas com curingas. Os endpoints podem assinar os…
2,993
Qual é o cronograma de tentativas de webhook do OpsIQ?
Após uma entrega de webhook inicial falhada, a sequência de tentativas documentada é a seguinte: 1 minuto 5 minutos 30 minutos 2 horas 12 horas Após a sexta tentativa total, a entrega é marcada como falhada. O histórico…
2,954
Integrações, API e Construtor de Conectores — OpsIQ
OpsIQ oferece uma plataforma robusta para integrar vários sistemas por meio de pacotes governados, APIs e webhooks assinados. Os usuários também podem construir, publicar e vender conectores através do Marketplace…
2,937
Quais são os tipos e perfis de capacidade do conector OpsIQ?
Tipos e Perfis de Capacidade do Conector OpsIQ O plano de controle de integração atualmente descreve 52 tipos de capacidade e 7 perfis iniciais. Um perfil representa uma forma comum de plataforma, como: API Padrão…
2,905
Quem pode baixar o software OpsIQ Self-Hosted?
Os downloads estão disponíveis para clientes Self-Hosted elegíveis quando os downloads estão habilitados e a assinatura ou teste relacionado está ativo. Clientes somente em nuvem normalmente usam seu espaço de trabalho…
2,891
A API do OpsIQ suporta idempotência?
Sim, o modelo de desenvolvedor inclui proteção de replay idempotente para gravações. Este recurso inclui uma janela de idempotência de 24 horas para operações suportadas. Os clientes devem reutilizar a mesma chave ao…
2,890
Como são assinados os webhooks de saída do OpsIQ?
O OpsIQ assina os payloads de webhook de saída usando HMAC-SHA256 sobre o corpo da requisição bruta. Também inclui metadados de entrega, como o timestamp e o evento. Os receptores devem seguir estes passos: Calcule a…
2,873
Posso agrupar vários Sites Remotos juntos?
Sim, Sites Remotos podem carregar identidade de grupo, o que ajuda espaços de trabalho de múltiplas marcas ou agências a organizar sites relacionados enquanto preservam o escopo a nível de site. Grupos melhoram a…
2,864
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 de API Geral nomeadas governadas por 62 escopos de menor privilégio. O registro de operações garante que o comportamento da API, a documentação…
2,858
A API do OpsIQ suporta solicitações de dry-run?
Sim, a API do OpsIQ suporta solicitações de dry-run. Operações suportadas podem utilizar o dry_run comportamento, permitindo que integradores validem a intenção e os parâmetros sem comprometer a gravação. Este recurso é…
2,821
OpsIQ pode se conectar a um backend personalizado?
Sim, OpsIQ pode se conectar a um backend personalizado. Um backend personalizado pode utilizar a API Geral, webhooks, Construtor de Conectores, ou endpoints explícitos de Ação de IA. A arquitetura deve expor apenas a…
2,808
Como o OpsIQ protege ações HTTP remotas contra SSRF?
Ações remotas utilizam endpoints declarados e incluem proteções contra falsificação de solicitação do lado do servidor (SSRF). Essas proteções vêm com várias opções de autenticação, incluindo Bearer, chave de API…
2,777
Como funciona o OpsIQ Connector Builder?
O Connector Builder utiliza seis etapas guiadas: Identidade, Autenticação, Teste de Conexão, Ações, Gatilhos, e Revisão. Os construtores podem começar a partir de OpenAPI, Postman, cURL, ou um perfil selecionado. As…
2,776
Todas as integrações do OpsIQ estão igualmente disponíveis?
Não, nem todas as integrações do OpsIQ estão igualmente disponíveis. Alguns conectores são agrupados como Disponibilidade Geral (GA), enquanto outros são agrupados como Pré-visualização. Além disso, pacotes de mercado…
2,717
OpsIQ funciona com WHMCS?
Sim, OpsIQ funciona com WHMCS. Hospedagem e WHMCS formam um padrão de solução de primeira classe. Um conector WHMCS pode fornecer contexto autenticado de cliente, serviço, fatura, domínio, pedido e suporte, e expor…
2,710
Como eu adiciono outro site ao OpsIQ?
Para adicionar outro site ao OpsIQ, siga estes passos: Crie um Site Remoto com as seguintes configurações: Rótulo Domínio Grupo Configuração de rastreamento Instale o trecho gerado que contém a chave única do site. O…
2,692
Um escaneamento de segurança do Marketplace pode rejeitar meu conector?
Sim, o Marketplace realiza verificações de segurança estáticas em pacotes de conectores enviados. Descobertas significativas podem resultar na retenção, rejeição ou quarentena do pacote para uma revisão adicional. É…
2,673
Quais formatos de referência de SDK e API o OpsIQ fornece?
OpsIQ fornece uma OpenAPI 3.0.3 descrição, recursos do 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…
2,660
Documentação do OpsIQ & Documentos para Desenvolvedores — OpsIQ
Visão Geral da Documentação do OpsIQ & Documentos para Desenvolvedores OpsIQ fornece documentação abrangente para que os usuários configurem, operem e ampliem sua plataforma de forma eficaz. Isso inclui orientações…
2,656
Cada Site Remoto pode ter branding diferente?
Sim, OpsIQ suporta branding e configuração por site enquanto mantém os sites sob um único espaço de trabalho. Este recurso é benéfico para grupos com várias marcas, sites regionais ou agências. Por favor, note que os…
2,651
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
Posso construir minha própria integração para OpsIQ?
Sim, você pode construir sua própria integração para OpsIQ usando o Connector Builder. Esta ferramenta permite que você defina identidade, autenticação, testes, ações, gatilhos e revise metadados. Você pode iniciar sua…
2,550
Como funciona a limitação de taxa de API no OpsIQ?
O OpsIQ aplica limites de taxa de 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,543
Posso usar webhooks para conectar OpsIQ a outro site ou aplicativo?
Usando Webhooks para Conectar OpsIQ Sim, você pode usar webhooks para conectar OpsIQ a outro site ou aplicativo. Webhooks assinados servem como um método de integração baseado em eventos, enquanto a API Geral e as Ações…
2,520
OpsIQ suporta integrações REST e GraphQL?
Sim, OpsIQ suporta integrações através de APIs padrão REST ou estilo GraphQL. O modelo de conector foca nas capacidades que o sistema externo expõe. Os métodos de autenticação incluem: Bearer chave da API Básico OAuth…
2,497
O que pode aparecer em Downloads Self-Hosted?
A conta pode publicar o pacote principal Self-Hosted e, dependendo da sua autorização e versão atual, pacotes adicionais de integração ou desenvolvedor. Os pacotes exatos, versões e disponibilidade são controlados pela…
2,493
Que informações posso ver sobre um token de API?
A API Tokens página 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 da 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
Posso ver meu histórico de downloads Self-Hosted?
Sim, você pode visualizar seu histórico de downloads onde a funcionalidade de download-history está disponível. O recurso Download History exibe quando um pacote foi baixado, junto com informações sobre o pacote e a…
2,456
Os clientes do Cloud precisam de uma chave de licença?
O acesso normal ao OpsIQ Cloud é baseado no espaço de trabalho de propriedade do cliente e sua concessão, em vez de na instalação de uma chave de licença Self-Hosted. As chaves de licença na conta do cliente são…
2,431
Webhooks Assinados e Ações de API para Automação — OpsIQ
OpsIQ oferece uma solução robusta para automatizar fluxos de trabalho por meio de webhooks assinados e ações de API. Com recursos como webhooks assinados com HMAC, eventos de entrada verificados e ações de backend…
2,424
O que são Sites Remotos no OpsIQ?
Sites Remotos permitem que um espaço de trabalho opere em vários websites. Cada site é atribuído a uma site_key única e um script de inserção. Esses sites reportam um heartbeat e podem ter sua própria configuração de…
2,414
Como faço para me autenticar na OpsIQ General API?
Autenticando-se na OpsIQ General API A OpsIQ's General API 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,406
Como faço para instalar a edição auto-hospedada?
Como instalar a edição auto-hospedada Para instalar a edição auto-hospedada, baixe o pacote atual disponível para sua concessão ativa de auto-hospedagem. Siga as orientações de instalação ou de início rápido fornecidas…
2,400
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 significa 'Não vinculado' em uma licença Self-Hosted?
O termo 'Não vinculado' indica que a licença atualmente não possui nenhum vínculo de domínio registrado na exibição da conta. O comportamento do vínculo de domínio pode variar dependendo do produto e do fluxo de…
2,383
O que significa GA, Preview ou contract-ready para um conector OpsIQ?
Entendendo GA, Preview e Contract-Ready para OpsIQ Connectors GA significa Disponibilidade Geral, o que significa que um pacote agrupado passou pela governança de lançamento de disponibilidade geral da plataforma…
2,379
Por que um pacote Auto-Hospedado é mostrado como indisponível?
Um pacote pode ser mostrado como indisponível por duas razões principais: ele não foi publicado para o seu direito, ou os requisitos de integridade de lançamento não foram atendidos. A conta evita intencionalmente…
2,378
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 a senha da sua conta. Esses tokens podem ter permissões limitadas para operações de conta, licença…
2,370
OpsIQ pode integrar com Shopify ou WooCommerce?
Sim, OpsIQ pode integrar com Shopify e WooCommerce. Os materiais de comércio e Sales Bridge da OpsIQ descrevem os padrões de integração para Shopify e WooCommerce, assim como outras plataformas de comércio. O comércio…
2,357
Fazer o upload de um ZIP de conector publica-o imediatamente?
Não, fazer o upload de um ZIP de conector não o publica imediatamente. Quando um autor faz o upload de um conector, ele cria uma submissão que passa por verificações e revisões automatizadas. A publicação do conector…
2,344
Como o OpsIQ impede que um Site Remoto veja os dados de outro site?
Como OpsIQ Previne a Visibilidade de Dados Entre Sites Remotos Os registros de sites remotos são atribuídos a um escopo de site específico, e OpsIQ implementa escopo a nível de linha para garantir que os dados sejam…
2,336
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
Por que não vejo o menu Downloads?
O menu é ciente de direitos e pode estar oculto se sua conta não tiver produtos Self-Hosted elegíveis ou se os downloads Self-Hosted estiverem desativados. Se você acredita que tem um direito Self-Hosted ativo, mas não…
2,308
Usuários autenticados podem se mover entre um portal OpsIQ e um domínio remoto?
OpsIQ descreve um token de identidade assinado de origem cruzada que é baseado na chave do site, segredo, informações de função/contexto e uma vida útil limitada. Este mecanismo permite que um site remoto estabeleça uma…
2,243
Posso usar um token de API do OpsIQ em vez da minha senha de conta para uma integração?
Sim, você pode usar um OpsIQ API token 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 pode…
1,951
Ainda precisa de ajuda?

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

Contatar suporte