Puedes definir la privacidad de tus APIs y métodos para otorgar acceso solo a los usuarios que desees, o revocar los accesos cuando lo requieras. La visibilidad se configura en dos niveles: la API, al crearla o editarla, y cada método, al crearlo o editarlo. En este video ves 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:
Ten 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 encuentras el bloque Uso con el selector Este recurso será Público / Privado para todos. Elige la opción, continúa hasta el paso de revisión y guarda. 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 cambias la visibilidad de una API ya publicada, publica nuevamente la versión para que el portal tome el cambio.
Al agregar o editar un método, en el bloque Seguridad encuentras el selector Este método será Público / Privado para todos. Guarda el método con Listo y publica 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 compartes. Vea Compartir métodos privados.
Los métodos privados se protegen con la llave de acceso de la aplicación del desarrollador. Puedes 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 tu cuenta tiene activada la protección de métodos mediante OAuth 2.0, el método privado puede protegerse con ese protocolo. Al hacerlo, debes completar un formulario con la configuración que corresponda y los desarrolladores utilizan el client_id y el client_secret de su aplicación para obtener un token de acceso.
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 compartiste. 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.