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.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.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.Os domínios do Apidog incluem: 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
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.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.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