Puede definir la privacidad de sus APIs y métodos para otorgar acceso solo a los usuarios que desee, o revocar los accesos cuando lo requiera. La visibilidad se configura en dos niveles: la API, al crearla o editarla, y cada método, al crearlo o editarlo. En este video ve cómo marcar un método como privado, qué cambia en el portal para desarrolladores y qué pasa cuando la API completa es privada.
Tanto las APIs como los métodos pueden ser públicos o privados. Las combinaciones posibles son estas:
Tenga en cuenta que las APIs no se comparten con los desarrolladores: lo que se comparte son sus métodos.
Al crear o editar una API, en el primer paso del asistente encuentra el bloque Uso con el selector Este recurso será Público / Privado para todos. Elija la opción, continúe hasta el paso de revisión y guarde. Si la API es privada, en su ficha y en el listado de APIs se muestra un ícono de candado junto al título.
Si cambia la visibilidad de una API ya publicada, publique nuevamente la versión para que el portal tome el cambio.
Al agregar o editar un método, en el bloque Seguridad encuentra el selector Este método será Público / Privado para todos. Guarde el método con Listo y publique la versión de la API.
En la ficha de la API, el método privado aparece con un candado en la lista de métodos y, al seleccionarlo, el detalle muestra un botón Compartir para elegir con qué desarrolladores, grupos o roles lo comparte. Vea Compartir métodos privados.
Los métodos privados se protegen con la llave de acceso de la aplicación del desarrollador. Puede configurar si la llave debe enviarse Como un parámetro, en cuyo caso viaja en el parámetro auth_key, o En una cabecera, en cuyo caso viaja como valor de la cabecera Authorization.
Cuando la cuenta tiene un proveedor OAuth 2.0 configurado en Configuraciones › Integraciones › OAuth2.0, un método privado puede protegerse con tokens de acceso en lugar de la llave de acceso. En el bloque Seguridad del método, con la visibilidad en Privado, haga clic en Habilitar OAuth 2.0 y defina los permisos (scopes) que exige el método, la vigencia del token y el algoritmo de firma. Si vuelve el método a Público, la protección OAuth 2.0 se quita.
El acceso se otorga por perfiles: en Cuenta › Perfiles se crea un perfil con esos permisos y los entornos donde aplica, y se asigna a grupos o usuarios. Los desarrolladores piden el token con el client_id y el client_secret de su aplicación y lo envían en la cabecera Authorization: Bearer. El detalle del flujo, con el video, está en Autenticación de APIs con API Keys y OAuth 2.0.
En el catálogo del portal para desarrolladores se muestran las APIs públicas y, en la solapa Compartidas conmigo, las APIs privadas con algún método compartido con ese usuario. Al abrir una API, los métodos privados llevan un candado; si el usuario no tiene acceso, en lugar del detalle se muestra el mensaje No se encuentra autorizado a ver el detalle de este método.
Las aplicaciones se gestionan en el portal para desarrolladores. Cada desarrollador puede crear, editar y eliminar sus aplicaciones, que contienen las credenciales para consultar los métodos: una API Key sin vencimiento, que el dueño de la aplicación puede refrescar, y, si la cuenta usa OAuth 2.0, un client_id y un client_secret.
Una API pública con un método privado aparece en el catálogo, pero el detalle del método solo lo ven los desarrolladores con los que lo compartió. Una API privada desaparece del catálogo público y solo la ven los desarrolladores que tienen al menos un método compartido. En el video, al pasar la API a privada, deja de aparecer en el catálogo del portal.