Comienza a usar el Portal de Cloud Endpoints

En esta página, se describe cómo crear un portal para tu servicio de Cloud Endpoints y se presenta la interfaz de usuario del portal. Para cada tarea, se proporcionan las funciones mínimas de Cloud Identity and Access Management que se requieren a fin de completarla. Si quieres obtener más información sobre los permisos de Cloud IAM, consulta los siguientes vínculos:

Requisitos previos

En esta página, se supone que ya hiciste lo siguiente:

Crea un portal

Para crear un portal, haz lo siguiente:

  1. En Google Cloud Console, ve a la página Endpoints > Portal para desarrolladores.

    Ir al Portal de Cloud Endpoints

  2. Selecciona el proyecto de Cloud en el que se encuentra la API.
  3. Haz clic en Crear portal. La creación del portal suele tardar entre 5 y 10 minutos. Cuando tu portal esté listo, se mostrará una URL que te llevará a él.

Cuando creas un portal, ocurre lo siguiente:

  • Durante la creación del portal, se crea una cuenta de servicio con el nombre service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com, con la función Agente de servicio del portal de Endpoints (YOUR_PROJECT_NUMBER es el número de tu proyecto de Cloud). Puedes ver esta cuenta de servicio en Cloud Console en la página IAM y administración> IAM de tu proyecto de Cloud.

  • Cuando se crea tu portal, este usa el nombre de dominio endpointsportal.YOUR_PROJECT_ID.cloud.goog. (YOUR_PROJECT_ID es el ID del proyecto de Cloud.) Para permitirlo, se crean un certificado SSL/TLS y un registro DNS público que contienen el ID del proyecto y se pueden buscar en los registros del Certificado de transparencia públicos, aunque tu portal no sea de acceso público.

Ver el portal para una API

Para ver el portal para una API:

  1. En la página Endpoints > Portal para desarrolladores, en la sección URL del portal, haz clic en la URL.
  2. Sigue los mensajes de acceso para continuar a tu portal. Si tienes más de una cuenta, asegúrate de elegir la que está en el proyecto de Cloud en el que se encuentra la API.

    Se muestra la página principal del portal. Para tu comodidad, te recomendamos que agregues esta URL a favoritos. La página principal del portal muestra una lista con vínculos a todas las API del proyecto de Cloud.

  3. Haz clic en la API que quieres explorar. Se mostrará la página principal de la API.

Presentación de la IU del portal

Los siguientes íconos, que se encuentran en la parte inferior de la página principal de tu API, proporcionan vínculos útiles para los usuarios de esta.

  • Referencia de la API muestra la primera página de la documentación de referencia de la API de SmartDocs que generó el portal de Endpoints desde tu archivo de configuración de servicio. Puedes utilizar la barra de navegación de la izquierda para ver la documentación de SmartDocs para cada método y recurso.

  • Comenzar muestra contenido de ejemplo de la guía de introducción. Antes de enviar la URL del portal a los usuarios de la API, personaliza esta documentación a fin de proporcionar la información que necesitan los usuarios de la API para comenzar a utilizarla en su código. Consulta Agregar documentación personalizada para obtener más información sobre cómo modificar el contenido de la guía de introducción.

  • Obtener una clave  muestra la página API y servicios > Biblioteca de API para que los usuarios puedan habilitar la API en sus propios proyectos de Google Cloud.

    Si tu API requiere una clave de API luego de que los usuarios habiliten la API, pueden dirigirse a la página API y servicios > Credenciales para obtener una clave de API que puedan utilizar en sus códigos. Antes de enviar la URL del portal a los usuarios de la API, debes otorgarles acceso para usar la API. Consulta Controlar quién puede habilitar tu API para obtener más información.

Personaliza la apariencia de tu portal

Se recomienda cambiar algunos elementos como los esquemas de colores y los íconos que se muestran en tu portal para que coincidan con el sitio web de tu empresa. Al realizar un cambio de apariencia y Configurar un dominio personalizado para tu portal, puedes crear una experiencia de marca para tus usuarios.

Para personalizar la apariencia de tu portal, haz lo siguiente:

  1. En la esquina superior derecha de la página, haz clic en Configuración settings.

  2. Haz clic en la pestaña Todo el sitio. Puedes cambiar la apariencia de los siguientes elementos:

    • Logotipo
    • Color primario: se utiliza como el color de fondo de la página de inicio y la barra de título
    • Color secundario: se utiliza como el color de los íconos y los vínculos
    • Título de la página de inicio
    • Descripción de la página de inicio
  3. Haz clic en Guardar.

Borrar un portal

Para borrar un portal, haz lo siguiente:

  1. En Cloud Console, ve a la página Endpoints > Portal para desarrolladores.

    Ir al Portal de Cloud Endpoints

  2. Selecciona el proyecto de Cloud en el que se encuentra la API.
  3. Haz clic en Borrar delete.
  4. En el diálogo de confirmación, haz clic en Borrar.

Pasos siguientes

Obtén más información sobre los siguientes temas: