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