- Centro de Aprendizagem da Apidog
- Primeiros passos
- Introdução ao Apidog
- Conceitos Básicos no Apidog
- Navegar no Apidog
- Início rápido
- Migração para o Apidog
- Apidog Europe
- Dados de API mock
- Conta e preferências
- Enviar requisições
- Visão geral
- Depuração de SSE
- Cliente MCP
- Socket.IO
- WebSocket
- Webhook
- SOAP ou WebService
- GraphQL
- gRPC
- Utilizar Agentes de Proxy de Pedido para Depuração
- Criar requisições
- Autenticação e autorização
- Resposta e cookies
- Desenvolver e depurar APIs
- Visão geral
- Gerar Pedidos
- Enviar Pedidos
- Casos de Depuração
- Casos de Teste
- Valores Dinâmicos
- Validação de Respostas
- Design-First vs Request-First
- Geração de Código
- Ambientes e variáveis
- Segredos do cofre
- Módulos de valores dinâmicos
- Pré e pós-processadores
- Depuração de APIs
- Projetar APIs
- Visão geral
- Criar um Novo Projeto de API
- Noções Básicas de Endpoints
- Diretrizes de Design de API
- Módulo
- Configurar vários exemplos de corpo do pedido
- Componentes
- Campos Comuns
- Parâmetros Globais
- Histórico de Alterações do Endpoint
- Comentários
- Gestão de Endpoints em Lote
- API de Protocolo Personalizado
- Modo Spec-first (Beta)
- Esquemas de segurança
- Recursos avançados
- Schemas
- Testes de API
- Publicar documentação de API
- Visão geral
- Tecnologias de API Suportadas
- Partilha Rápida
- Visualizar a Documentação da API
- Documentação Markdown
- Publicar Sites de Documentação
- Página de Início de Sessão Personalizada
- Layouts personalizados
- CSS, JavaScript, HTML personalizados
- Domínio Personalizado
- Funcionalidades de IA
- Definições de SEO
- Configurações avançadas
- Versões da API
- Branches
- Recursos de IA
- Servidor MCP do Apidog
- Boas práticas
- Espaço offline
- Administração
- Cobrança
- Complementos
- Dados e segurança
- Referências
- Central de suporte
- Apidog Support Center
- Importar/exportar
- Envio de requisições
- O Apidog suporta Socket.IO?
- Porque é que o "+" no valor do parâmetro é descodificado como um espaço?
- Como enviar um pedido no Apidog?
- Como enviar um pedido GraphQL no Apidog?
- Como enviar um pedido gRPC no Apidog?
- Como enviar um pedido SOAP/WebService no Apidog?
- Como enviar um pedido WebSocket no Apidog?
- O Apidog suporta scripts pré-pedido/teste e asserções em APIs WebSocket?
- Como enviar um pedido SSE no Apidog?
- Como adicionar cabeçalhos predefinidos ao nível da pasta?
- O Apidog suporta scripts pré-pedido/de teste e asserções em APIs gRPC?
- Erro do resolvedor DNS ELANREFUSED.DNS
- Porque estou a receber um erro "socket hang up" ao enviar um pedido?
- Correção de erros de requisição
- Projeto de APIs
- Como utilizo variáveis no caminho?
- Posso utilizar um componente de resposta como resposta predefinida?
- Como verificar quem modificou um endpoint?
- Como posso eliminar pastas de endpoints em massa no Apidog?
- Como posso adicionar/remover prefixos em massa ao caminho dos endpoints?
- Como mover o nível de uma propriedade no Editor de Esquemas?
- Se uma propriedade de string tiver vários valores enumerados e for utilizada em vários locais, como é que este enum pode ser referenciado de forma consistente em todo o lado?
- Como obter o ID da pasta de recursos do Apidog?
- Como posso obter o ID da pasta de recursos do Apidog?
- Como utilizo variáveis num caminho de URL?
- O que deve fazer se um endpoint, documento ou cenário de teste for eliminado acidentalmente?
- O Apidog suporta código de pedido para endpoints personalizados?
- Como agrupar automaticamente endpoints ao importar Swagger/OpenAPI para o Apidog?
- Como gero dados de array não duplicados em respostas mock?
- Porque é que a entrada "#" não é suportada no caminho?
- Depuração de APIs
- Como é que o Apidog se integra com sistemas de gestão de chaves de terceiros?
- Porque é que o mesmo pedido funciona corretamente noutras ferramentas (como o Postman), mas não no Apidog?
- Como obter valores de variáveis a partir da base de dados no Apidog?
- Como migrar ambientes de outras ferramentas para o Apidog?
- Como criar asserções utilizando scripts no Apidog?
- JSONPath só consegue extrair arrays. Como podemos extrair um único elemento dentro deles no Apidog?
- Como configurar operações de base de dados no Apidog quando diferentes ambientes têm diferentes credenciais de conta da base de dados?
- Como obter o URL base do serviço num script personalizado?
- Porque é que o Apidog comunica um erro de excesso do comprimento máximo de string do Node.js quando a resposta da API é demasiado grande?
- Qual é o limite de tamanho para a impressão na consola? Porque recebo um erro ao imprimir ficheiros grandes?
- Como resolver erros de ligação à base de dados DB2 no Windows?
- Porque estou a obter o erro NJS-045 ao ligar-me a uma base de dados Oracle no Apidog?
- Como gerar valores dinâmicos em scripts personalizados do Apidog?
- Porque é que o pedido do cliente para o mesmo endpoint é bem-sucedido, mas ocorre um erro ao depurar no lado web: "Não é possível solicitar o endereço"?
- Porque é que o Apidog comunica um erro quando a resposta é demasiado grande?
- Como posso utilizar o endpoint de gravação do Apidog?
- Ao definir uma resposta de endpoint, é permitido que o endpoint não tenha conteúdo de resposta?
- Como obtenho a baseURL do serviço num script personalizado?
- Como posso visualizar o pacote original no Apidog?
- Porque é que vejo o erro "Invalid URI xxx" ao fazer um pedido?
- Como faço um pedido assíncrono num script do Apidog?
- Porque vejo a mensagem "Couldn't resolve host" ao enviar um pedido?
- Qual é o limite de tamanho de impressão na consola? Porque ocorre um erro ao imprimir um ficheiro grande?
- Como faço para carregar um ficheiro num pedido de endpoint?
- O que fazer se o Apidog falhar ou os dados da resposta não forem apresentados?
- URI de Redirecionamento Oficial utilizado pelo Apidog para OAuth2.0
- Dados de API mock
- Como simular APIs automaticamente?
- O que pode fazer o mocking do Apidog?
- Como fazer mock de dados fixos de API no Apidog?
- Como simular dados condicionais no Apidog?
- Como ativar o mock na cloud no Apidog?
- Como ativar o mock autoalojado no Apidog?
- O Apidog suporta mocks de APIs WebSocket?
- Porque é que o browser não devolve conteúdo ao solicitar o endpoint mock?
- Testes automatizados
- Porque é que os cenários de teste são executados sem problemas no meu cliente local, mas ocorrem erros ao executá-los na CLI ou no runner do Apidog?
- Como criar um cenário de teste no Apidog?
- Como passar dados entre etapas de teste?
- Porque não consigo referenciar com êxito dados do passo anterior?
- Como utilizar o ciclo foreach no Apidog?
- Quais são as diferenças entre sincronizar dados de endpoints/casos de endpoint?
- Como utilizar dados de teste no Apidog?
- Como obter dados de teste em scripts no Apidog?
- Como executar cenários de teste em lote no Apidog?
- Como agendar tarefas de teste no Apidog?
- Como executar um teste de desempenho no Apidog?
- Como pode visualizar os pedidos e as respostas reais nos testes de desempenho?
- Como posso exportar relatórios de testes de desempenho no Apidog?
- Como utilizar resultados de consultas à base de dados como parâmetros para pedidos de API em loop?
- Capturar e Validar Webhooks do Stripe no ApiDog Durante CI/CD
- Como resolver o erro "Error: unable to verify the first certificate on runner"?
- Erro "Not Found" no Contentor Docker do General Runner.
- Como definir o host do servidor para o General Runner na versão Web do Apidog?
- Porque é que o cenário de teste agendado terminou com 0 pedidos?
- O que deve fazer se o parâmetro de carregamento de ficheiro não for encontrado no Runner ou na CLI?
- Como utilizar o Runner para executar um cenário de teste com um passo de carregamento de ficheiro?
- Como resolvo o erro "Error: unable to verify the first certificate on runner"?
- Como pode aceder e pesquisar os logs do runner para identificar o problema quando surge um problema com um runner?
- O que devo fazer se o parâmetro do endpoint for um ficheiro de upload e não puder ser encontrado no Runner ou na CLI?
- Porque é que os passos de teste não são sincronizados automaticamente quando o caso de uso da API muda?
- Porque é que a utilização de vários sinais de dólar num documento Markdown faz com que algum conteúdo não seja apresentado corretamente?
- O Runner autoalojado gera um relatório de teste no servidor após executar uma tarefa?
- Posso adicionar pré/pós-processadores unificados a pedidos num cenário de teste?
- Como posso manter valores dinâmicos consistentes durante uma única execução de teste automatizado?
- Publicar documentação de API
- Como ocultar todos os logótipos da Apidog em documentos publicados?
- Quando a especificação da API é atualizada, a documentação da API muda?
- Como partilhar APIs com colaboradores no Apidog?
- Como personalizar o domínio das documentações do Apidog?
- Como criar documentação multiversão no Apidog?
- Âmbito de partilha para Sites de Documentação Publicados no Apidog
- Âmbito de partilha da lista Share Doc no Apidog
- Porque é que a documentação partilhada publicada não mostra o hostname?
- Como podem os utilizadores da documentação modificar a URL Base em documentação partilhada?
- Posso duplicar um documento Apidog publicado para usar no meu próprio projeto?
- Como Partilhar Cabeçalhos (por exemplo, Token) na Documentação Online do Apidog?
- Porque é que o membro da minha equipa não consegue encontrar a documentação publicada?
- Como corrijo a expiração de um certificado SSL ou um erro 526 da Cloudflare no meu domínio personalizado?
- SMTP personalizado configurado com sucesso, mas os utilizadores na lista de permissões não recebem e-mails com OTP
- Markdown
- Como utilizar cartões para ligar a várias páginas ou endpoints dentro do Apidog?
- Porque é que algum conteúdo não é apresentado corretamente ao utilizar vários símbolos $ em documentos Markdown?
- Como utilizar imagens com fundo transparente no Markdown do Apidog?
- Como definir a largura das colunas de uma tabela Markdown?
- Como pode inserir APIs internas, documentos, esquemas de dados ou pastas num documento Markdown?
- Como posso adicionar uma ligação a um documento ou endpoint dentro de um projeto num componente de cartão do Apidog?
- Branches
- Administração
- Como instalar o cliente Apidog silenciosamente?
- Porque estou a ver um erro “No Permission” apesar de ter acesso de administrador?
- Como posso verificar o número da versão do runner?
- O Apidog suporta Windows 7?
- Porque é que o Apidog apresenta o erro "Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll" após a instalação?
- Alterações de Subscrição e Reembolsos
- Os pedidos Web funcionam, mas a aplicação apresenta "read ECONNRESET" — Porquê?
- Porque não consigo abrir o Apidog após uma atualização do sistema Windows?
- Porque é que o Apidog não abre após uma atualização do sistema Windows
- Cobrança
- On-premises
- Web e cliente
Webhook
Casos de Utilização Comuns#
| Caso de Utilização | Descrição |
|---|---|
| Notifica ções de Pagamento | A plataforma de pagamento envia uma notificação quando uma encomenda é paga com sucesso |
| Atualizações de Autenticação | O serviço de início de sessão de terceiros atualiza o estado de início de sessão |
| Resultados de Tarefas Assíncronas | As tarefas em segundo plano enviam resultados após a conclusão |
| Acionadores de Eventos | O sistema notifica serviços externos quando ocorrem eventos específicos |
Principal Diferença em Relação a Endpoints Normais#
Criar um Endpoint de Webhook#
1
No seu projeto Apidog, clique no ícone "+" na barra lateral esquerda e escolha "New Other Protocol APIs" → "Webhook".
2
Depois de criar o Webhook, preencha os seguintes campos no editor:
| Campo | Descrição |
|---|---|
| Método do Pedido | Normalmente POST |
| Nome do Webhook | Aparece na documentação da API e na exportação OpenAPI (por exemplo, order) |
| URL de Depuração | Opcional. URL real utilizado para enviar pedidos de teste (apenas para testes, não incluído na documentação) |
| Outras Informações | Corpo do pedido, cabeçalhos e outra configuração |
3
Clique em "Save" depois de preencher todos os campos obrigatórios.
Depurar um Endpoint de Webhook#
1.
2.
Documentação de Webhooks#
Privacidade do URL de Depuração
webhooks, que é diferente do campo paths dos endpoints normais.Perguntas Frequentes#
Por que razão definir Webhooks separadamente na documentação?
De acordo com a especificação OpenAPI 3.1:Os endpoints normais são definidos no campo Os endpoints de Webhook são definidos no campo Esta separação clara garante que: Os endpoints normais são chamados por clientes externos para executar ações ou obter dados Os Webhooks são acionados pelo sistema para notificar serviços externos No Apidog, os Webhooks são tratados como um tipo de endpoint distinto para refletir com precisão esta diferença direcional e garantir a formatação correta nas exportações OpenAPI. Exemplo:
pathswebhooks/orders é um endpoint normal utilizado por clientesorderPaid é um Webhook acionado pelo sistema quando uma encomenda é paga com sucessoUm Webhook é apenas um endpoint normal?
O URL de Depuração aparecerá na minha documentação da API?
Modified at 2026-06-09 08:54:45