API de proyecto opcional
Muestre las operaciones de la aplicación acordadas cuando las necesite
Revise el alcance de una API para un proyecto elegible y distinga las rutas previstas de los endpoints ya construidos.
Trate la API como una opción definida del proyecto
- Revise la opción
Compruebe la disponibilidad de la API y la oferta del proyecto correspondiente.
- Defina el alcance de las rutas
Precise las operaciones de negocio que debe exponer la API.
- Consulte el catálogo de rutas
Consulte el método, la ruta y el estado previsto o activo de cada ruta.
Añada una API cuando su proyecto la necesite
La API del proyecto es una parte opcional de la oferta. Revise su alcance y sus condiciones antes de la activación, en lugar de suponer que todas las aplicaciones la incluyen.
Las herramientas de API organizan las rutas propuestas por área de negocio. Las aclaraciones ayudan a definir lo que debe hacer cada operación antes de su implementación.
Distinga las rutas previstas de los endpoints operativos
Prepare el acceso para otro sistema. Un proyecto puede necesitar que otra aplicación utilice sus operaciones de negocio. Revise el alcance y la oferta de la API opcional en lugar de suponer que todas las funciones se exponen automáticamente. Las operaciones acordadas definen a qué debe acceder la integración.
Consulte el catálogo de rutas. El catálogo muestra el método, la ruta, la descripción y el estado de cada ruta. Ayuda a distinguir el alcance propuesto de los endpoints registrados como activos. Es una referencia práctica para seguir la preparación de la API.
Elija la dirección de integración correcta. Utilizar la API de otro proveedor y exponer su propia aplicación son necesidades distintas. Las conexiones externas cubren lo primero; la API del proyecto cubre la exposición acordada. Elija la vía que corresponda al intercambio de negocio que busca.
Distinga una API expuesta de una conexión externa
Una API de proyecto expone las operaciones acordadas de su aplicación. Una conexión externa describe cómo su aplicación utiliza otro servicio; responden a necesidades distintas.
Utilice el catálogo de rutas para consultar el método, la ruta y si un endpoint está previsto o activo. Esta presentación no activa ninguna API para su proyecto.
Evalúe la opción de API frente a una necesidad concreta
Identifique quién consumirá los datos del proyecto y qué operaciones requiere esa integración. Esto ayuda a distinguir un alcance de API opcional de una conexión a un servicio externo existente.
En un proyecto elegible, consulte las rutas previstas y su estado de construcción. Confirme el servicio y el entorno correspondientes antes de considerar un endpoint disponible para una integración.
De un alcance opcional a una exposición verificada
Revise la disponibilidad y las condiciones. Compruebe la opción de API en la oferta real del proyecto. Decida si la aplicación necesita esa exposición antes de la activación.
Precise las operaciones. Revise las operaciones de negocio propuestas y responda a las preguntas sobre su comportamiento esperado. Siga los estados de preparación y de construcción.
Consulte lo que está activo. Consulte el catálogo de rutas y la referencia publicada de un proyecto activado. Una ruta prevista no es un endpoint operativo.
Defina el alcance de la integración antes de añadir una API
Explique las operaciones que necesita otro sistema y revise las condiciones de la opción. La API debe servir a un intercambio de negocio acordado.
Preguntas sobre la API de proyecto opcional
Es una opción cuya disponibilidad y precio aparecen en la oferta real. Una aplicación puede funcionar sin activarla. Esta presentación no aprovisiona ni habilita ninguna API para su proyecto.
Describe una operación prevista que todavía no está registrada como endpoint activo. Utilice el estado del catálogo y la referencia publicada real antes de iniciar una integración.
Las vistas de la API del proyecto muestran las áreas que se van a exponer, las preguntas, la infraestructura y los estados de construcción. Resuelva los requisitos previos indicados y consulte el catálogo de rutas resultante.
Utilice la referencia de la API correspondiente al proyecto activado y al entorno pertinente. No deduzca un endpoint ni un ejemplo de autenticación solo a partir de una ruta prevista.
Describen otro servicio que utiliza su aplicación. Esa dirección de integración es distinta de exponer las operaciones de su propia aplicación mediante la API del proyecto.