Apidog Docs
🇧🇷 Português (Brasil)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇧🇷 Português (Brasil)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇧🇷 Português (Brasil)
  • 🇺🇸 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 Aprendizado da Apidog
  • Primeiros passos
    • Introdução ao Apidog
    • Conceitos básicos no Apidog
    • Navegando pelo Apidog
    • Início rápido
      • Visão geral
      • Criando um Endpoint
      • Fazendo uma Requisição
      • Adicionando uma assertiva
      • Criação de Cenários de Teste
      • Compartilhamento da 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 do Insomnia
        • Importar do apiDoc
        • Importar arquivo .har
        • Importar WSDL
  • Dados de API mock
    • Visão geral
    • Smart Mock
    • Mock personalizado
    • Sequência de Prioridade do Mock
    • Scripts de Mock
    • Mock na Nuvem
    • Mock do Runner Auto-hospedado
    • Idioma do Mock (Locales)
  • Conta e preferências
    • Configurações da Conta
    • Geração de Token de Acesso OpenAPI
    • Notificação
    • Configurações de idioma
    • Teclas de Atalho
    • Configuração de Proxy de Rede
    • Backup de Dados
    • Atualizando o Apidog
    • Exclusão da conta
    • Recursos Experimentais
  • Enviar requisições
    • Visão geral
    • Depuração de SSE
    • Cliente MCP
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP ou WebService
    • GraphQL
    • gRPC
    • Use Agentes de Proxy de Requisição para Depuração
    • Criar requisições
      • Histórico de Requisições
      • Conceitos Básicos de Requisições
      • Parâmetros e Corpo
      • Cabeçalhos da Requisição
      • Configurações da Requisição
      • Depurar Requisições
      • Salvando Requisições como Endpoints
      • HTTP/2
    • Autenticação e autorização
      • Visão geral
      • Certificados de CA e de Cliente
      • Tipos de autorização
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Autenticação Hawk
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Resposta e cookies
      • Visualização de respostas de API
      • Gerenciamento de Cookies
      • Visão geral
  • Desenvolver e depurar APIs
    • Visão geral
    • Gerando Requisições
    • Envio de Requisições
    • 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
      • Usando variáveis
      • Gerenciamento 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
      • Banco de Dados
      • Tipo de dados
      • Data
      • Finanças
      • Comida
      • Git
      • Hacker
      • Helpers
      • Imagem
      • Internet
      • Localização
      • Lorem
      • Música
      • Número
      • Pessoa
      • Telefone
      • Ciência
      • String
      • Sistema
      • Veículo
      • Palavra
    • Pré e pós-processadores
      • Visão geral
      • Assertiva
      • 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é-processador
        • Scripts de Pós-processamento
        • Scripts Públicos
        • Referência de Scripts do Postman
        • Chamando Outras Linguagens de Programação
        • Usando bibliotecas JS
        • Visualização de Respostas
        • Exemplos de scripts
          • Scripts de assertiva
          • Usando Variáveis
          • Modificando Requisições
          • Outros exemplos
    • Depuração de APIs
      • AI Agent Debugger
      • A2A Debugger
  • Projetar APIs
    • Visão geral
    • Criar um Novo Projeto de API
    • Conceitos Básicos de Endpoint
    • Diretrizes de Design de API
    • Módulo
    • Configurar vários exemplos de corpo da requisição
    • Componentes
    • Campos Comuns
    • Parâmetros Globais
    • Histórico de Alterações do Endpoint
    • Comentários
    • Gerenciamento 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
      • Usar o Security Scheme
      • Esquema de segurança na documentação online
    • Recursos avançados
      • Campos de Endpoint Personalizados
      • Cenários de Teste Associados
      • Status 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 schemas a partir de JSON etc.
      • oneOf, allOf, anyOf
      • Usando Discriminator
  • Branches
    • Visão geral
    • Criando uma Branch de Sprint
    • Testando APIs em uma Branch
    • Projetando APIs em uma branch
    • Mesclando branches de sprint
    • Gerenciando Branches de Sprint
    • AI Branch (Beta)
  • Testes de API
    • Visão geral
    • Cenários de teste
      • Criar um cenário de teste
      • Passar Dados Entre Requisições
      • Condições de Controle 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 Compartilhados
      • Tarefas agendadas
      • Gerenciar o ambiente de execução de APIs de outros projetos
    • Suíte de testes
      • Visão geral
      • Criar Uma Suíte de Testes
      • Orquestrar Suite de Testes
      • Executar Suítes de Teste Localmente
      • Executar Suítes de Teste Via CLI
      • Tarefas agendadas
    • Testar APIs
      • Teste de integração
      • Teste de desempenho
      • Testes de Ponta a Ponta
      • Teste de regressão
      • Teste de Contrato
    • Apidog CLI
      • Visão geral
      • Instalando e executando o Apidog CLI
      • Opções da CLI do Apidog
    • CI/CD
      • Visão geral
      • Integrar com Github Actions
      • Integre com o Gitlab
      • Integrar com o Jenkins
      • Acionar teste por commit do Git
  • Publicar documentação de API
    • Visão geral
    • Tecnologias de API Suportadas
    • Compartilhamento rápido
    • Visualização da documentação da API
    • Documentação em Markdown
    • Publicação de sites de documentação
    • Página de login personalizada
    • Layouts Personalizados
    • CSS, JavaScript e HTML personalizados
    • Domínio Personalizado
    • Recursos de IA
    • Configurações de SEO
    • Configurações avançadas
      • Pesquisa na documentação
      • Proxy CORS
      • Integração com o Google Analytics
      • Configurações da Árvore de Pastas
      • Configurações de Visibilidade
      • Incorporação de valores em URLs de documentação
    • Versões da API
      • Visão geral
      • Criando versões de API
      • Publicação de Versões da API
      • Compartilhamento de Endpoints com Versões da API
  • Recursos de IA
    • Visão geral
    • Habilitando recursos de IA
    • Geração de Casos de Teste
    • Modificando esquemas com IA
    • Verificação de conformidade de endpoint
    • Verificação de Completude da Documentação da API
    • Nomeação de Campos com IA
    • Perguntas frequentes
  • Servidor MCP do Apidog
    • Visão geral
    • Conectar projeto Apidog à IA
    • Conectar documentação publicada à IA
    • Conectar Arquivos OpenAPI à IA
  • Boas práticas
    • Como lidar com assinaturas de API
    • Acessando APIs protegidas por OAuth 2.0
    • Fluxo de Trabalho de Colaboração
    • Gerenciamento do Estado de Autenticação
  • Espaço offline
    • Visão geral
  • Administração
    • Gerenciamento de projetos
      • Gerenciamento de Projetos
      • Configurações de notificação
      • Gerenciamento de membros do projeto
      • Recursos do projeto
        • Conexão com Banco de Dados
        • Conexão Git
    • Gerenciamento de equipes
      • Gerenciando equipes
      • Gerenciando membros da equipe
      • Atividades da Equipe
      • Funções e permissões da equipe
      • Recursos da equipe
        • General Runner
        • Variáveis de Equipe
        • Agente de Proxy de Requisições
      • Colaborações em tempo real
        • Colaboração em Equipe
    • Checklist de integração
      • Conceitos Básicos
      • Guia de Onboarding
    • Gerenciamento da organização
      • Gerenciamento de Organização
      • Funções e permissões da organização
      • Gerenciamento de planos
        • Gerentes de cobrança em organizações
      • Single Sign-On (SSO)
        • Visão geral do SSO
        • Configurando o Microsoft Entra ID
        • Configurando o Okta
        • Configurando SSO para uma organização
        • Gerenciamento de contas de usuário
        • Mapeamento de Grupos para Equipes
      • Provisionamento SCIM
        • Introdução ao provisionamento SCIM
        • Microsoft Entra ID
        • Okta
      • Recursos da organização
        • Runner Auto-Hospedado
  • Apidog Europe
    • Apidog Europe
  • Cobrança
    • Visão geral
    • Créditos
    • Atualizando seu plano
    • Métodos de Pagamento Alternativos
    • Gerenciamento de assinaturas
    • Movendo equipes pagas para organizações
  • Complementos
    • Hub de APIs
    • Plugin Apidog Intellij IDEA
    • Extensão do navegador
      • Chrome
      • Microsoft Edge
    • Proxy de requisições
      • Proxy de Requisição na Web
      • Proxy de Requisição em Documentação Compartilhada
      • Proxy de Requisição no Cliente
  • Dados e segurança
    • Armazenamento e Segurança de Dados
    • Privacidade e Segurança dos Dados do Usuário
    • Roteamento de Requisições e Segurança de Dados
  • Referências
    • Abordagem API Design-First
    • Extensões da especificação OpenAPI do Apidog
    • JSONPath
    • XPath
    • Expressões Regulares
    • JSON Schema
    • Formato de Arquivo CSV
    • Instalando o ambiente Java
    • Ambiente de Implantaçã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 Onboarding

Para começar a usar o Apidog em sua organização, você pode seguir as tarefas abaixo para configurar sua equipe do Apidog para o sucesso. Recomenda-se que você primeiro colabore com os Administradores da Equipe e com a equipe de TI da sua organização para configurar, proteger e gerenciar o Apidog na sua organização. Em seguida, você pode configurar sua equipe do Apidog definindo as configurações relevantes, convidando pessoas para sua equipe e atribuindo funções a elas, além de criar recursos relacionados aos seus projetos.
Você pode baixar e instalar o aplicativo desktop do Apidog para Windows, Mac e Linux. Você também pode acessar o Apidog pela web com o Apidog Agent.

Colabore com sua equipe de TI#

Entre em contato com sua equipe de TI para estabelecer o procedimento de adição de um novo software, que varia de uma organização para outra. Os seguintes tópicos são comuns:
Sua equipe de TI pode precisar adicionar uma exceção à política de dispositivos para permitir que o Apidog seja instalado nas estações de trabalho dos funcionários. Forneça um link de download do Apidog à equipe de TI para ajudar a estabelecer essa exceção.
Se a conexão de rede da sua organização estiver atrás de um proxy, talvez você precise configurar o Apidog adequadamente. Obtenha os detalhes da conexão proxy com sua equipe de TI e configure-os no Apidog.
INFO
Se você já estiver conectado ao Apidog, poderá configurar um proxy navegando até a opção ⚙Settings → Proxy, localizada no canto superior direito da interface do Apidog. Como alternativa, se você ainda não estiver conectado ao Apidog, poderá configurar as definições de proxy no canto inferior esquerdo da tela de login no aplicativo cliente do Apidog.
Se sua organização operar atrás de um firewall, sua equipe de TI talvez precise configurar listas de permissões para os domínios do Apidog. Isso garante que os dados do Apidog sejam sincronizados com a nuvem e que todas as funcionalidades operem conforme esperado.
INFO
Os domínios do Apidog incluem:
*.apidog.com
*.apidog.io

Configure a equipe do Apidog#

Primeiro, você precisa decidir qual membro da sua organização será o Administrador da Equipe. O Administrador da Equipe pode registrar uma conta do Apidog, criar uma nova equipe e tornar-se automaticamente o Proprietário da Equipe dessa nova equipe.
O proprietário da equipe tem as seguintes permissões:
Modificar informações da equipe
Criar novo projeto
Convidar e remover membros
Definir permissões de equipe e permissões de projeto para outros membros
Gerenciar assinaturas e pagamentos
Transferir e dissolver a equipe
Uma equipe pode consistir em vários membros e gerenciar diversos projetos. Os administradores têm autoridade para determinar quais membros têm quais permissões dentro de projetos específicos.
Na versão gratuita do Apidog, uma equipe pode ter no máximo 4 membros. Se sua equipe exceder 4 membros, você precisará fazer upgrade para o plano pago do Apidog.

Gerencie membros da equipe#

O proprietário da equipe pode convidar alguns outros membros para serem administradores da equipe, que então serão responsáveis por convidar e gerenciar membros colaborativos adicionais dentro da equipe.
Os administradores da equipe podem convidar outros membros para ingressar na equipe por e-mail ou por links de convite. Ao convidar membros para ingressar, eles podem definir as permissões padrão dos membros em relação aos projetos dentro da equipe. Essas permissões normalmente incluem Admin, Editor, Somente leitura e Proibido.
É importante observar que, no Apidog, permissões de Equipe e permissões de Projeto são níveis de autorização distintos. As permissões de Equipe são utilizadas para gerenciar a equipe como um todo, abrangendo configurações da Equipe, gerenciamento de membros e governança geral da equipe. As permissões de Equipe incluem funções como Proprietário da equipe, Administrador da Equipe, Membro da equipe e Convidado.
Por outro lado, as permissões de Projeto são especificamente adaptadas para gerenciar projetos individuais dentro da equipe. Essas permissões controlam aspectos relacionados às configurações do projeto, controle de acesso e colaboração dentro do escopo do projeto. As permissões de Projeto consistem em funções como Admin, Editor, Somente leitura ou Proibido, que determinam o nível de controle e acesso que os membros da equipe têm dentro de um projeto específico.

Crie projetos#

Proprietários da equipe e administradores da equipe podem criar novos projetos dentro da equipe. Ao criar um projeto, você pode especificar o nome e a descrição do projeto e selecionar o modelo de projeto apropriado com base em suas necessidades.
Depois de criar um projeto, você pode convidar membros da equipe para ingressar no projeto e atribuir a eles as permissões de projeto apropriadas. Isso permite que os membros da equipe colaborem no projeto e acessem recursos do projeto com base nas permissões atribuídas.

Migre dados#

Se você estiver migrando de outra ferramenta de gerenciamento de APIs para o Apidog, poderá importar seus dados de API existentes para o Apidog. O Apidog oferece suporte à importação de dados de vários formatos, incluindo OpenAPI/Swagger, Postman e outros.
Para importar dados, navegue até as configurações do projeto e selecione a opção Import Data. Escolha o formato de importação apropriado e siga as instruções na tela para concluir o processo de importação.

Configure as definições iniciais#

Depois de configurar sua equipe e criar projetos, você pode definir as configurações iniciais para personalizar o Apidog de acordo com as necessidades da sua organização. Isso inclui:
Configurações da Equipe: Configure definições no nível da equipe, como nome, descrição e avatar da equipe.
Configurações do Projeto: Configure definições no nível do projeto, como nome, descrição e ambiente padrão do projeto.
Variáveis de Ambiente: Configure variáveis de ambiente para gerenciar diferentes ambientes (por exemplo, desenvolvimento, staging, produção).
Configurações de Notificação: Configure as definições de notificação para receber alertas sobre eventos importantes.
Seguindo estas etapas, você pode configurar o Apidog na sua organização e começar a colaborar no design, desenvolvimento e documentação de APIs com sua equipe.
Modified at 2026-06-11 10:21:25
Previous
Conceitos Básicos
Next
Gerenciamento da organização
Built with