Para comenzar a usar Apidog dentro de su organización, puede completar las siguientes tareas para preparar a su equipo de Apidog para el éxito. Se recomienda que primero colabore con los administradores de su equipo y con el equipo de TI de su organización para configurar, proteger y gestionar Apidog en su organización. Luego puede configurar su equipo de Apidog ajustando la configuración relevante, invitando personas a su equipo y asignándoles roles, y creando recursos relacionados con sus proyectos.Puede descargar e instalar la aplicación de escritorio de Apidog para Windows, Mac y Linux. También puede acceder a Apidog en la web con Apidog Agent.
Póngase en contacto con su equipo de TI para establecer el procedimiento para añadir un nuevo software, el cual varía de una organización a otra. Los siguientes temas son comunes:
Es posible que su equipo de TI deba añadir una excepción a la política de dispositivos que permita instalar Apidog en las estaciones de trabajo de los empleados. Proporcione un enlace de descarga de Apidog al equipo de TI para ayudar a establecer esta excepción.
Si la conexión de red de su organización está detrás de un proxy, es posible que deba configurar Apidog adecuadamente. Obtenga los detalles de conexión del proxy de su equipo de TI y configúrelos dentro de Apidog.
INFO
Si ya ha iniciado sesión en Apidog, puede configurar un proxy navegando a la opción ⚙Configuración → Proxy, ubicada en la esquina superior derecha de la interfaz de Apidog. Como alternativa, si aún no ha iniciado sesión en Apidog, puede configurar los ajustes del proxy en la esquina inferior izquierda de la pantalla de inicio de sesión en la aplicación cliente de Apidog.
Si su organización opera detrás de un firewall, es posible que su equipo de TI deba configurar listas de permitidos para los dominios de Apidog. Esto garantiza que los datos de Apidog se sincronicen con la nube y que toda la funcionalidad opere según lo esperado.
Primero, debe decidir qué miembro de su organización será el administrador del equipo. El administrador del equipo puede registrar una cuenta de Apidog, crear un nuevo equipo y convertirse automáticamente en el propietario del equipo de este nuevo equipo.El propietario del equipo tiene los siguientes permisos:
Modificar la información del equipo
Crear un nuevo proyecto
Invitar y eliminar miembros
Establecer permisos de equipo y permisos de proyecto para otros miembros
Gestionar suscripciones y pagos
Transferir y disolver el equipo
Un equipo puede constar de varios miembros y gestionar diversos proyectos. Los administradores tienen la autoridad para determinar qué miembros tienen qué permisos dentro de proyectos específicos.En la versión gratuita de Apidog, un equipo puede tener un máximo de 4 miembros. Si su equipo supera los 4 miembros, deberá actualizar al plan de pago de Apidog.
El propietario del equipo puede invitar a otros miembros a ser administradores del equipo, quienes luego serán responsables de invitar y gestionar a miembros colaboradores adicionales dentro del equipo.Los administradores del equipo pueden invitar a otros miembros a unirse al equipo por correo electrónico o mediante enlaces de invitación. Al invitar a miembros a unirse, pueden establecer los permisos predeterminados para los miembros respecto a los proyectos dentro del equipo. Estos permisos suelen incluir Administrador, Editor, Solo lectura y Prohibido.Es importante tener en cuenta que, en Apidog, los permisos de equipo y permisos de proyecto son niveles de autorización distintos. Los permisos de equipo se utilizan para gestionar el equipo en su conjunto, lo que abarca la configuración del equipo, la gestión de miembros y la gobernanza general del equipo. Los permisos de equipo incluyen roles como propietario del equipo, administrador del equipo, miembro del equipo e invitado.Por otro lado, los permisos de proyecto están diseñados específicamente para gestionar proyectos individuales dentro del equipo. Estos permisos rigen aspectos relacionados con la configuración del proyecto, el control de acceso y la colaboración dentro del alcance del proyecto. Los permisos de proyecto constan de roles como Administrador, Editor, Solo lectura o Prohibido, que determinan el nivel de control y acceso que los miembros del equipo tienen dentro de un proyecto en particular.
Los propietarios del equipo y los administradores del equipo pueden crear nuevos proyectos dentro del equipo. Al crear un proyecto, puede especificar el nombre y la descripción del proyecto, y seleccionar la plantilla de proyecto adecuada según sus necesidades.Después de crear un proyecto, puede invitar a miembros del equipo a unirse al proyecto y asignarles los permisos de proyecto adecuados. Esto permite que los miembros del equipo colaboren en el proyecto y accedan a los recursos del proyecto según sus permisos asignados.
Si está migrando de otra herramienta de gestión de API a Apidog, puede importar sus datos de API existentes a Apidog. Apidog admite la importación de datos desde varios formatos, incluidos OpenAPI/Swagger, Postman y otros.Para importar datos, navegue a la configuración del proyecto y seleccione la opción Importar datos. Elija el formato de importación adecuado y siga las instrucciones en pantalla para completar el proceso de importación.
Después de configurar su equipo y crear proyectos, puede configurar los ajustes iniciales para personalizar Apidog según las necesidades de su organización. Esto incluye:
Configuración del equipo: Configure ajustes a nivel de equipo, como el nombre del equipo, la descripción y el avatar.
Configuración del proyecto: Configure ajustes a nivel de proyecto, como el nombre del proyecto, la descripción y el entorno predeterminado.
Variables de entorno: Configure variables de entorno para gestionar diferentes entornos (por ejemplo, desarrollo, staging, producción).
Configuración de notificaciones: Configure los ajustes de notificaciones para recibir alertas sobre eventos importantes.
Al seguir estos pasos, puede configurar Apidog dentro de su organización y comenzar a colaborar con su equipo en el diseño, desarrollo y documentación de API.
