Compartir métodos privados a usuarios registrados
Resumen
Cuando haya definido sus métodos con visibilidad Privado, deberá compartirlos con los usuarios desarrolladores registrados que deban tener acceso. El acceso se otorga por método, nunca por API, y puede darse a un usuario, a un grupo de usuarios o a todos los usuarios con cierto rol. En este video ve cómo crear un grupo, cómo compartir un método privado por usuario y por grupo, y qué ve el desarrollador en el portal una vez compartido.
Antes de comenzar
- El método debe tener visibilidad Privado. Vea Configurar privacidad de APIs y métodos.
- Los desarrolladores deben existir como usuarios de la cuenta. Para compartir con un grupo, cree el grupo en Configuraciones › Cuenta › Grupos con Agregar Nuevo Grupo: nombre, descripción y los usuarios que pasa de Disponibles a Agregados con el botón +. Vea Gestionar grupos de usuarios.
Compartir acceso
Los métodos pueden estar protegidos por API Keys o mediante el protocolo OAuth 2.0, y el acceso se otorga de forma distinta en cada caso.
Métodos protegidos por API Keys
En la ficha de la API, seleccione el método en la lista de métodos de la versión y haga clic en el ícono de compartir del detalle del método. Se abre la ventana Comparte este método con desarrolladores, con tres formas de otorgar acceso:
- Por rol: en Invitá todos los usuarios con cierto rol, elija el rol y el alcance y haga clic en Agregar. Compartir con un rol también comparte con los roles de mayor nivel: Administrador, Publicador, Editor.
- Por usuario: en Invitá desarrolladores, escriba el nombre de usuario o el email del desarrollador y presione Enter. Los desarrolladores invitados reciben un correo con instrucciones.
- Por grupo: en Grupos con acceso, seleccione el grupo y haga clic en Agregar. Todos los integrantes del grupo quedan con acceso al método, incluidos los que se agreguen al grupo más adelante.
Cada invitación pendiente queda como una etiqueta debajo de su sección. Haga clic en Guardar: el acceso aplica de inmediato y, al volver a abrir la ventana, la columna ¿Quién tiene acceso? lista los usuarios, grupos y roles con acceso.
Si desea revocar un acceso, abra la ventana nuevamente, elimine la entrada correspondiente y haga clic en Guardar.
Métodos protegidos por OAuth 2.0
En caso de que el método se encuentre protegido por OAuth 2.0, el acceso se otorga a través de perfiles OAuth: un perfil agrupa los scopes y entornos necesarios para acceder al método y puede asignarse de dos formas.
- Asignación directa al usuario: desde la ficha del usuario (Configuraciones › Cuenta › Usuarios), seleccionando el perfil en el campo Perfil OAuth.
- Asignación por grupo: agregando el perfil en la sección Perfiles del formulario del grupo (Configuraciones › Cuenta › Grupos). Todos los usuarios del grupo heredan automáticamente los scopes del perfil.
Los perfiles se crean en Configuraciones › Cuenta › Perfiles. Para más información, consulte Gestionar perfiles OAuth.
Qué ve el desarrollador
En el portal para desarrolladores, el catálogo muestra la solapa Compartidas conmigo con las APIs que tienen al menos un método compartido con el usuario, de forma directa, por su grupo o por su rol. Al abrir la API, el método compartido muestra su detalle completo y puede probarse desde el portal. Los métodos privados no compartidos siguen con candado y el mensaje de que no está autorizado a ver su detalle.
Resultado esperado
Después de guardar, el desarrollador invitado ve la API en Compartidas conmigo aunque la API sea privada, y puede consultar el método con la llave de acceso de su aplicación. En el video, la API privada aparece en el catálogo del desarrollador recién después de compartir el método con su usuario y con su grupo.
Errores frecuentes
- El desarrollador no ve la API: el método no fue compartido con su usuario, su grupo ni su rol, o no se hizo clic en Guardar.
- El desarrollador ve la API pero no el detalle del método: tiene acceso a otro método de la misma API, no a este. Comparta también este método.
- El botón de compartir no aparece: el método es público, o está protegido con OAuth 2.0, en cuyo caso el acceso se otorga por perfiles.
- Un usuario conserva el acceso después de quitarlo del grupo: la sincronización tarda unos segundos y un token OAuth ya emitido sigue vigente hasta que expira.