Apidog Docs
🇵🇹 Português (Portugal)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇵🇹 Português (Portugal)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇵🇹 Português (Portugal)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. Checklist de integração
  • Centro de Aprendizagem da Apidog
  • Primeiros passos
    • Introdução ao Apidog
    • Conceitos Básicos no Apidog
    • Navegar no Apidog
    • Início rápido
      • Visão geral
      • Criar um Endpoint
      • Fazer um Pedido
      • Adicionar uma asserção
      • Criar Cenários de Teste
      • Partilhar Documentação da API
      • Explore Mais
    • Migração para o Apidog
      • Visão geral
      • Importação Manual
      • Importação Agendada (Vincular Fontes de Dados)
      • Opções de Importação
      • Exportar Dados
      • Importar de
        • Importar do Postman
        • Importar especificação OpenAPI
        • Importar cURL
        • Importar Markdowns
        • Importar a partir do Insomnia
        • Importar a partir de apiDoc
        • Importar Ficheiro .har
        • Importar WSDL
  • Apidog Europe
    • Apidog Europe
  • Dados de API mock
    • Visão geral
    • Smart Mock
    • Mock personalizado
    • Sequência de Prioridade do Mock
    • Scripts de Mock
    • Mock na Cloud
    • Mock do Runner Autoalojado
    • Idioma de Mock (Localidades)
  • Conta e preferências
    • Definições da Conta
    • Gerar um Token de Acesso OpenAPI
    • Notificações
    • Definições de Idioma
    • Teclas de Atalho
    • Configuração de Proxy de Rede
    • Cópia de Segurança dos Dados
    • Atualizar o Apidog
    • Eliminar Conta
    • Funcionalidades Experimentais
  • 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
      • Histórico de Pedidos
      • Noções Básicas de Pedidos
      • Parâmetros e Corpo
      • Cabeçalhos do Pedido
      • Definições do Pedido
      • Depurar Pedidos
      • Guardar Pedidos como Endpoints
      • HTTP/2
    • Autenticação e autorização
      • Visão geral
      • Certificados CA e de Cliente
      • Tipos de autorização
      • Autenticação Digest
      • OAuth 1.0
      • OAuth 2.0
      • Autenticação Hawk
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Resposta e cookies
      • Visualizar Respostas de API
      • Gerir Cookies
      • Visão geral
  • 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
      • Visão geral
      • Utilizar Variáveis
      • Gestão de Ambientes
    • Segredos do cofre
      • Visão geral
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Módulos de valores dinâmicos
      • Airline
      • Animal
      • Cor
      • Comércio
      • Empresa
      • Base de Dados
      • Tipo de dados
      • Data
      • Finanças
      • Alimentação
      • Git
      • Hacker
      • Helpers
      • Imagem
      • Internet
      • Localização
      • Lorem
      • Música
      • Número
      • Pessoa
      • Telefone
      • Ciência
      • String
      • Sistema
      • Veículo
      • Word
    • Pré e pós-processadores
      • Visão geral
      • Asserção
      • Extrair variável
      • Espera
      • Segurança
      • Operações de banco de dados
        • Visão geral
        • MySQL
        • MongoDB
        • Redis
        • Cliente Oracle
      • Uso de scripts
        • Visão geral
        • Scripts de Pré-processamento
        • Scripts de pós-processamento
        • Scripts Públicos
        • Referência de Scripts do Postman
        • Chamar Outras Linguagens de Programação
        • Utilizar Bibliotecas JS
        • Visualizar Respostas
        • Exemplos de scripts
          • Scripts de Asserção
          • Utilização de Variáveis
          • Modificar Pedidos
          • Outros exemplos
    • Depuração de APIs
      • Depurador de Agentes de IA
      • Depurador A2A
  • 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
      • Visão geral
      • Criar um Esquema de Segurança
      • Utilizar o Esquema de Segurança
      • Esquema de Segurança na Documentação Online
    • Recursos avançados
      • Campos de Endpoint Personalizados
      • Cenários de Teste Associados
      • Estado do endpoint
      • Aparência das listas de parâmetros
      • Identificação Única de Endpoint
    • Schemas
      • Visão geral
      • Criar um Novo Schema
      • Criar um Schema
      • Gerar esquemas a partir de JSON, etc.
      • oneOf, allOf, anyOf
      • Utilizar Discriminator
  • Testes de API
    • Visão geral
    • Cenários de teste
      • Criar um Cenário de Teste
      • Passar Dados Entre Pedidos
      • Condições de Controlo de Fluxo
      • Sincronizar Dados de Endpoints e Casos de Endpoint
      • Importar Endpoints e Casos de Endpoint de Outros Projetos
      • Exportar Cenários de Teste
    • Relatórios de teste
      • Relatórios de Teste
    • Executar cenários de teste
      • Executar um cenário de teste
      • Executar cenários de teste em lote
      • Testes Orientados por Dados
      • Dados de Teste Partilhados
      • Tarefas agendadas
      • Gerir o ambiente de runtime de APIs de outros projetos
    • Suíte de testes
      • Visão geral
      • Criar Uma Suite de Testes
      • Orquestrar Conjunto de Testes
      • Executar Conjuntos de Testes Localmente
      • Executar conjuntos de testes via CLI
      • Tarefas agendadas
    • Testar APIs
      • Testes de Integração
      • Testes de desempenho
      • Testes de Ponta a Ponta
      • Teste de regressão
      • Testes de Contrato
    • Apidog CLI
      • Visão geral
      • Instalar e Executar o Apidog CLI
      • Opções da CLI do Apidog
    • CI/CD
      • Visão geral
      • Integrar com o Github Actions
      • Integrar com o Gitlab
      • Integrar com Jenkins
      • Acionar Teste por Commit Git
  • 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
      • Pesquisa na Documentação
      • Proxy CORS
      • Integrar o Google Analytics
      • Definições da Árvore de Pastas
      • Definições de Visibilidade
      • Incorporar Valores em URLs de Documentação
    • Versões da API
      • Visão geral
      • Criar Versões de API
      • Publicar versões de API
      • Partilhar Endpoints com Versões da API
  • Branches
    • Visão geral
    • Criar uma Branch de Sprint
    • Testar APIs numa Branch
    • Conceber APIs numa Ramificação
    • Mesclar Branches de Sprint
    • Gerir Branches de Sprint
    • AI Branch (Beta)
  • Recursos de IA
    • Visão geral
    • Ativar Funcionalidades de IA
    • Gerar Casos de Teste
    • Modificar esquemas com IA
    • Verificação de Conformidade do Endpoint
    • Verificação da Completude da Documentação da API
    • Nomeação de Campos com IA
    • Perguntas frequentes
  • Servidor MCP do Apidog
    • Visão geral
    • Ligar o Projeto Apidog à IA
    • Ligar Documentação Publicada à IA
    • Ligar Ficheiros OpenAPI à IA
  • Boas práticas
    • Tratamento de Assinaturas de API
    • Aceder a APIs Protegidas por OAuth 2.0
    • Fluxo de trabalho de colaboração
    • Gestão do Estado de Autenticação
  • Espaço offline
    • Visão geral
  • Administração
    • Gerenciamento de projetos
      • Gerir Projetos
      • Definições de Notificação
      • Gerir Membros do Projeto
      • Recursos do projeto
        • Ligação à Base de Dados
        • Ligação Git
    • Gerenciamento de equipes
      • Gerir Equipas
      • Gerir Membros da Equipa
      • Atividades da Equipa
      • Funções e permissões da equipa
      • Recursos da equipe
        • General Runner
        • Variáveis de Equipa
        • Agente Proxy de Pedidos
      • Colaborações em tempo real
        • Colaboração em Equipa
    • Checklist de integração
      • Conceitos Básicos
      • Guia de Integração Inicial
    • Gerenciamento da organização
      • Gerir a Organização
      • Funções e Permissões da Organização
      • Gerenciamento de planos
        • Gestores de Faturação em Organizações
      • Single Sign-On (SSO)
        • Visão Geral do SSO
        • Configurar o Microsoft Entra ID
        • Configurar o Okta
        • Configurar SSO para uma organização
        • Gerir Contas de Utilizador
        • Mapear Grupos para Equipas
      • Provisionamento SCIM
        • Introdução ao Provisionamento SCIM
        • Microsoft Entra ID
        • Okta
      • Recursos da organização
        • Self-Hosted Runner
  • Cobrança
    • Visão geral
    • Créditos
    • Atualizar o seu plano
    • Métodos de Pagamento Alternativos
    • Gestão de Subscrições
    • Mover Equipas Pagas para Organizações
  • Complementos
    • API Hub
    • Plugin Apidog Intellij IDEA
    • Extensão do navegador
      • Chrome
      • Microsoft Edge
    • Proxy de requisições
      • Proxy de pedidos na Web
      • Proxy de Pedidos em Documentação Partilhada
      • Proxy de Pedido no Cliente
  • Dados e segurança
    • Armazenamento e Segurança de Dados
    • Privacidade e Segurança dos Dados do Utilizador
    • Encaminhamento de Pedidos e Segurança dos Dados
  • Referências
    • Abordagem API Design-First
    • Extensões da Especificação OpenAPI do Apidog
    • JSONPath
    • XPath
    • Expressões Regulares
    • JSON Schema
    • Formato de ficheiro CSV
    • Instalar o Ambiente Java
    • Ambiente de Implementação do Runner
    • Sintaxe Markdown do Apidog
    • Extensões Swagger do Apidog
      • Visão geral
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Extensões JSON Schema do Apidog
      • Visão geral
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • Central de suporte
  1. Checklist de integração

Guia de Integração Inicial

Para começar a utilizar o Apidog na sua organização, pode seguir as seguintes tarefas para preparar a sua equipa Apidog para o sucesso. Recomenda-se que colabore primeiro com os Administradores da equipa e com a equipa de TI da sua organização para configurar, proteger e gerir o Apidog na sua organização. Em seguida, pode configurar a sua equipa Apidog ao definir as configurações relevantes, convidar pessoas para a sua equipa e atribuir-lhes funções, bem como criar recursos relacionados com os seus projetos.
Pode transferir e instalar a aplicação de ambiente de trabalho do Apidog para Windows, Mac e Linux. Também pode aceder ao Apidog na Web com o Apidog Agent.

Colaborar com a sua equipa de TI#

Contacte a sua equipa de TI para estabelecer o procedimento para adicionar um novo software, que varia de organização para organização. Os seguintes tópicos são comuns:
A sua equipa de TI poderá ter de adicionar uma exceção à política de dispositivos para permitir que o Apidog seja instalado nas estações de trabalho dos colaboradores. Forneça uma ligação de transferência do Apidog à equipa de TI para ajudar a estabelecer esta exceção.
Se a ligação de rede da sua organização estiver atrás de um proxy, poderá ter de configurar o Apidog adequadamente. Obtenha os detalhes da ligação proxy junto da sua equipa de TI e configure-os no Apidog.
INFO
Se já tiver sessão iniciada no Apidog, pode configurar um proxy ao navegar para a opção ⚙Definições → Proxy, localizada no canto superior direito da interface do Apidog. Em alternativa, se ainda não tiver sessão iniciada no Apidog, pode configurar as definições de proxy no canto inferior esquerdo do ecrã de início de sessão na aplicação cliente do Apidog.
Se a sua organização operar atrás de uma firewall, a sua equipa de TI poderá ter de configurar listas de permissões para os domínios do Apidog. Isto garante que os dados do Apidog são sincronizados com a cloud e que todas as funcionalidades funcionam conforme esperado.
INFO
Os domínios do Apidog incluem:
*.apidog.com
*.apidog.io

Configurar a equipa Apidog#

Primeiro, tem de decidir qual membro da sua organização será o Administrador da equipa. O Administrador da equipa pode registar uma conta Apidog, criar uma nova equipa e tornar-se automaticamente o Proprietário da equipa desta nova equipa.
O proprietário da equipa tem as seguintes permissões:
Modificar informações da equipa
Criar novo projeto
Convidar e remover membros
Definir permissões da equipa e permissões de projeto para outros membros
Gerir subscrições e pagamentos
Transferir e dissolver a equipa
Uma equipa pode ser composta por vários membros e gerir diversos projetos. Os administradores têm autoridade para determinar quais membros têm que permissões em projetos específicos.
Na versão gratuita do Apidog, uma equipa pode ter no máximo 4 membros. Se a sua equipa exceder 4 membros, terá de atualizar para o plano pago do Apidog.

Gerir membros da equipa#

O proprietário da equipa pode convidar alguns outros membros para serem administradores da equipa, que ficarão então responsáveis por convidar e gerir membros colaborativos adicionais dentro da equipa.
Os administradores da equipa podem convidar outros membros para se juntarem à equipa por e-mail ou através de ligações de convite. Ao convidar membros para aderirem, podem definir as permissões predefinidas dos membros relativamente aos projetos dentro da equipa. Estas permissões incluem normalmente Administrador, Editor, Só leitura e Proibido.
É importante notar que, no Apidog, as permissões da equipa e permissões do projeto são níveis de autorização distintos. As permissões da equipa são utilizadas para gerir a equipa como um todo, abrangendo as definições da equipa, a gestão de membros e a governação geral da equipa. As permissões da equipa incluem funções como Proprietário da equipa, Administrador da equipa, Membro da equipa e Convidado.
Por outro lado, as permissões do projeto são especificamente concebidas para gerir projetos individuais dentro da equipa. Estas permissões governam aspetos relacionados com as definições do projeto, o controlo de acesso e a colaboração no âmbito do projeto. As permissões do projeto consistem em funções como Administrador, Editor, Só leitura ou Proibido, que determinam o nível de controlo e acesso que os membros da equipa têm dentro de um projeto específico.

Criar projetos#

Os proprietários da equipa e os administradores da equipa podem criar novos projetos dentro da equipa. Ao criar um projeto, pode especificar o nome e a descrição do projeto, e selecionar o modelo de projeto apropriado com base nas suas necessidades.
Depois de criar um projeto, pode convidar membros da equipa para aderirem ao projeto e atribuir-lhes as permissões de projeto apropriadas. Isto permite que os membros da equipa colaborem no projeto e acedam aos recursos do projeto com base nas permissões que lhes foram atribuídas.

Migrar dados#

Se estiver a migrar de outra ferramenta de gestão de API para o Apidog, pode importar os seus dados de API existentes para o Apidog. O Apidog suporta a importação de dados de vários formatos, incluindo OpenAPI/Swagger, Postman e outros.
Para importar dados, navegue até às definições do projeto e selecione a opção Importar dados. Escolha o formato de importação apropriado e siga as instruções no ecrã para concluir o processo de importação.

Configurar definições iniciais#

Depois de configurar a sua equipa e criar projetos, pode configurar definições iniciais para personalizar o Apidog de acordo com as necessidades da sua organização. Isto inclui:
Definições da equipa: Configure definições ao nível da equipa, como o nome, a descrição e o avatar da equipa.
Definições do projeto: Configure definições ao nível do projeto, como o nome, a descrição e o ambiente predefinido do projeto.
Variáveis de ambiente: Configure variáveis de ambiente para gerir diferentes ambientes (por exemplo, desenvolvimento, staging, produção).
Definições de notificação: Configure as definições de notificação para receber alertas sobre eventos importantes.
Ao seguir estes passos, pode configurar o Apidog na sua organização e começar a colaborar com a sua equipa na conceção, desenvolvimento e documentação de APIs.
Modified at 2026-06-09 08:54:45
Previous
Conceitos Básicos
Next
Gerenciamento da organização
Built with