Después de escribir la documentación de su API y prepararse para publicarla, surge una pregunta clave: ¿Quién debería poder verla?
¿Debería la documentación ser completamente pública? ¿O restringida a su equipo interno? Quizás sus socios externos necesitan acceso, pero no cualquiera.
Crear una versión separada de la documentación para cada escenario sería lento e ineficiente. En realidad, las necesidades de acceso suelen ser muy específicas: quizás solo un departamento debería verla, o quizás sus socios solo deberían acceder desde su red corporativa.
Afortunadamente, Apidog ofrece múltiples opciones de control de acceso para satisfacer todas estas necesidades. Al publicar un sitio de documentación, simplemente seleccione el método de control de acceso que se adapte a su caso de uso.
1. Público: Cualquiera puede verlo
Si su API está abierta para uso público, como la API abierta de su producto, simplemente configure el control de acceso en "Público". Cualquiera con el enlace puede ver la documentación.
Consejo profesional: Apidog también cuenta con un API Hub, una plataforma tipo marketplace donde los desarrolladores pueden buscar y descubrir APIs. Publique su documentación allí para aumentar la visibilidad y la adopción.
2. Protegido con contraseña: Barrera simple
A veces no desea que su documentación sea completamente pública, pero tampoco quiere una configuración compleja. La protección con contraseña es una solución sencilla: establezca una contraseña y solo quienes la conozcan podrán acceder a la documentación.
La configuración es sencilla:
- Elija "Protegido con contraseña"
- Establezca una contraseña manualmente o deje que el sistema genere una
- Compártala con compañeros de trabajo o socios
Ideal para: Compartir a corto plazo o temporalmente, como permitir que un socio revise el diseño de su API. Después, simplemente actualice la contraseña o retire la publicación de la documentación. Simple y limpio.
Pero tenga en cuenta: Las contraseñas pueden compartirse sin intención. Si necesita un control más estricto, considere otras opciones.
3. Lista blanca de IP: Restringir el acceso a redes específicas
Si su equipo o socios se encuentran en ubicaciones de oficina fijas, la lista blanca de IP puede ser su mejor opción.
Funciona así:
- Solo los usuarios de las direcciones IP o rangos especificados pueden acceder a la documentación
- Las IP no autorizadas son denegadas automáticamente
Piense en ello como un firewall para su documentación.
Ideal para:
- Entornos corporativos
- Limitar el acceso a su red interna
- Permitir el acceso de socios solo desde la red de su oficina
Puede configurar una única IP o un rango de IP completo.
Extra: También puede habilitar la lista blanca de IP para el acceso a proyectos de equipo en la Configuración del equipo de Apidog (requiere el plan Enterprise). Una vez habilitado, solo los usuarios de las IP permitidas pueden acceder a sus proyectos internos.
4. Lista blanca de correo electrónico: Acceso basado en la identidad
¿Le preocupa que las contraseñas puedan filtrarse o que las IP cambien con frecuencia? La lista blanca de correo electrónico es una alternativa flexible y segura.
Simplemente agregue las direcciones de correo electrónico de su equipo o socios a la lista blanca. Los usuarios pueden acceder a la documentación mediante un código de verificación de correo electrónico de un solo uso.
También admite comodines; por ejemplo, *@apidog.com permite que todos los usuarios con el dominio de su empresa accedan a la documentación.
Beneficios:
- Fácil de gestionar: agregue o elimine usuarios según sea necesario
- Más seguro que las contraseñas: los usuarios no autorizados no pueden ver la documentación incluso si tienen el enlace
- Ideal para equipos distribuidos o trabajadores móviles
5. Página de inicio de sesión personalizada: Integrar con su propio sistema de autenticación
Si ninguno de los métodos anteriores satisface sus necesidades, existe una opción más avanzada: Página de inicio de sesión personalizada. Esto le permite conectar su propio sistema de autenticación para controlar el acceso.
Así es como funciona:
- Cuando un usuario intenta acceder al sitio de documentación, es redirigido a su página de inicio de sesión.
- Después de la autenticación, su servidor genera un token JWT.
- El usuario es redirigido de nuevo al sitio de documentación con el token como parámetro.
- Apidog verifica el token y concede el acceso si es válido.
Este enfoque le permite definir permisos exactamente según las necesidades de su negocio. Aunque requiere cierto desarrollo, es ideal para empresas con necesidades complejas de control de acceso.
Consulte la Documentación de ayuda para obtener detalles sobre la implementación de una página de inicio de sesión personalizada.
Cómo elegir el método de control de acceso adecuado
Con tantas opciones, quizás se pregunte: ¿Cuál debería elegir?
Depende de su caso de uso:
| Caso de Uso | Método Recomendado |
|---|---|
| APIs públicas, desean exposición | Acceso Público |
| Trabajo en equipo o compartición externa a corto plazo | Protección con Contraseña |
| Redes internas o de socios seguras | Lista Blanca de IP |
| Controlar el acceso por identidad de usuario | Lista Blanca de Correo Electrónico |
| Usar su propio sistema de inicio de sesión | Página de Inicio de Sesión Personalizada |
Consejo: Puede combinar varios métodos. Por ejemplo:
- Use una lista blanca de IP para miembros del equipo interno
- Use una lista blanca de correo electrónico para socios externos
- Use protección con contraseña para demostraciones temporales
Con Apidog, puede publicar múltiples sitios de documentación, cada uno con su propio control de acceso y un conjunto adaptado de puntos finales de API. Eso significa que las diferentes audiencias solo ven lo que necesitan, ni más ni menos.