Crear, Editar y Eliminar APIs

Creación de una API

Para crear una nueva API manualmente, puede hacer clic en el botón Create API, representado por el icono + en la esquina inferior derecha de la pantalla. Si simplemente deja el cursor sobre el botón, aparecen otras tres opciones:

api home

En total, por lo tanto, tiene estas cuatro formas de crear una API:

  • Create API: permite crear una API introduciendo todos los datos manualmente.

  • Import API from Swagger: permite crear una API importando un archivo Swagger, en formato JSON o YAML.

  • Create API GraphQL: permite crear una API GraphQL introduciendo manualmente los datos requeridos. Puede ver más sobre GraphQL aquí.

  • Create API Identity: permite crear una API Identity introduciendo manualmente los datos requeridos. Puede ver más sobre API Identity aquí.

Después de elegir una de las opciones anteriores, se mostrará la pantalla de registro y se deberán rellenar los campos requeridos (a menos que decida importar un archivo Swagger, que ya crea la API, con la posibilidad de editar los campos). La pantalla de registro manual de la API es esta:

create api

Si un entorno ya está registrado en Environments, se muestra la opción Deployable Environments. De lo contrario, el entorno se puede agregar más adelante (leer más sobre esto en esta sección).

La opción Access token expires in determina el período de tiempo de caducidad de tokens para una API determinada. Si no establece un valor, el tiempo predeterminado (10 segundos) es válido.

La opción Context está relacionada con la visibilidad de su API, que solo se mostrará a los usuarios autorizados. Las opciones son:

  • Organization: la API será visible para todos los usuarios que hayan iniciado sesión en el sistema;

  • Teams: la API será visible para los usuarios miembros del equipo seleccionado. Para obtener más información sobre la creación de equipos, consulte aquí;

  • Only me: la API será visible sólo para el usuario que la creó;

  • Add users: la API también será visible para los usuarios agregados, como se muestra en la siguiente imagen:

api add user

Se mostrarán todos los usuarios existentes en el API Manager. Para cambiar el permiso de un usuario específico, simplemente elija entre las opciones Can view (puede ver) o Can edit (puede editar).

Aunque la opción Can edit concede al usuario seleccionado permiso para editar la información de la API, este permiso no superará las reglas de acceso definidas en la configuración de rol de ese usuario.

Para configurar correctamente las opciones de visibilidad de su API, los usuarios y equipos deben estar ya registrados. Para obtener más información sobre la creación de usuarios, acceder a en esta página; para obtener más información sobre los diferentes roles de acceso, acceder a esta página.

La opción Private API, cuando está activada, no permite que la API esté disponible para su consumo en el Portal de Desarrolladores.

Al hacer clic en Save and next, se guardarán los datos básicos de la API. Los dos pasos siguientes (Resources y Flows) no son obligatorios (sin embargo, si la importación de un Swagger se había realizado anteriormente, los datos de recursos ya se completarán). Para más detalles, acceder a las páginas sobre Resources y Flows.

El último paso para crear la API es la pantalla Publish:

create api publish

Es posible realizar el despliegue de la API en un entorno si la opción Environments fue seleccionada al inicio del registro. También puede crear plantillas de prueba, que generarán un plan y una aplicación vinculados a la API registrada. Esta opción le permitirá usar su API inmediatamente.

Una vez registradas, las APIs se organizan en tarjetas (lea más sobre ellas aquí).

card api

Editar o eliminar una API

Para acceder a la pantalla de edición y eliminación de API, hacer clic en la tarjeta de una API. Se le dirigirá a la pantalla Overview. La información puede editarse haciendo clic en el botón Edit. En la esquina inferior derecha, hay el botón Delete para eliminar la API. Consulte más información sobre la pantalla Overview aquí.

editing
api action overview
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]