Menú

Contactar
Logo
Prensa

Gestión de API

Interfaces abiertas. Límites claros.

Los socios y las aplicaciones necesitan interfaces en cuyo comportamiento puedan confiar. Diseñamos los contratos de API, configuramos el acceso y la protección en el gateway, y organizamos las versiones, la documentación y las aprobaciones durante todo el ciclo de vida.

En esta página

Su encargo a OTOKO®

Lo que hacemos por usted.

Empezamos con los procesos de los sistemas conectados: ¿qué datos necesitan, qué estados pueden modificar y cómo detectan los errores? REST, GraphQL o gRPC se eligen según el caso de uso. La descripción utiliza el formato adecuado para el protocolo, por ejemplo OpenAPI para las API HTTP correspondientes. Además de la carga útil, se definen la paginación, los límites de tiempo, las respuestas de error y el comportamiento ante reintentos. Los ejemplos y los casos de prueba ayudan a los equipos consumidores a integrar la interfaz antes de la aprobación para producción.

El posible alcance del servicio

  • Guía de API con convenciones de nomenclatura, formatos de error, versionado y requisitos de seguridad
  • Catálogo de interfaces con especificación OpenAPI y responsable por API
  • Creación del gateway con Kong, Apigee o Azure API Management, conectado a su gestión de identidades mediante OAuth 2.0 y OpenID Connect
  • Portal para socios y desarrolladores con gestión de accesos, claves e informes de uso
  • Ciclo de vida con proceso de aprobación, retirada de versiones antiguas y notificaciones de cambios

Antes de comenzar, definimos el alcance concreto, su participación y los criterios de aceptación.

Tecnología explicada con claridad

Así llevamos a cabo la tarea.

01

El gateway y la aplicación asumen comprobaciones distintas

Un gateway puede gestionar los accesos, limitar las solicitudes y aplicar reglas técnicas. Además, debe ser el servicio responsable quien decida si un usuario concreto puede leer un pedido determinado. Planificamos la comprobación de tokens, las identidades de servicio, la asignación de inquilinos y el registro a lo largo de este límite. En las llamadas de escritura se define cómo se tratan las solicitudes repetidas. Las versiones antiguas reciben un proceso de retirada claro, para que los cambios no interrumpan de forma inesperada las conexiones con los socios.

02

Realizar la aceptación con los consumidores

Las pruebas de contrato comprueban la estructura acordada; las pruebas de integración y de carga cubren además el comportamiento. Probamos los accesos denegados, las entradas no válidas y los tiempos de espera agotados, así como las llamadas correctas. El traspaso incluye la especificación, la configuración del gateway y las responsabilidades. Para empezar necesitamos los consumidores típicos, las hipótesis de carga y los procesos de negocio que la API debe hacer posibles.

Sala de reuniones en la oficina de OTOKO® en Colonia

Un resultado verificable

Con este resultado puede seguir trabajando.

  1. Guía de API y catálogo de interfaces
  2. Gateway de API operativo conectado a la gestión de identidades
  3. Portal para desarrolladores con documentación por API

El traspaso une la implementación y la documentación. Juntos revisamos los casos acordados y registramos las tareas pendientes.

Su proyecto en detalle

Operar las interfaces como un acceso controlado a sus sistemas.

Diseñamos las API de forma que los equipos internos y los socios externos puedan utilizarlas con fiabilidad. Esto incluye un contrato comprensible, permisos de acceso claros y una operación que gestiona de forma visible los errores y la sobrecarga.

De la función de negocio a un contrato de API estable

Una API debería ofrecer una función de negocio comprensible y no exponer sin filtrar las tablas de un sistema interno. Definimos recursos, acciones, campos obligatorios y respuestas de error junto con los equipos consumidores. Los datos de ejemplo y una descripción legible por máquina facilitan la integración; las reglas de negocio quedan documentadas de forma explícita.

Los cambios se evalúan según su impacto. Un campo opcional adicional se trata de forma distinta a un nuevo valor obligatorio o a un cambio de significado. Planificamos el versionado, los plazos de transición y la comunicación a los usuarios conocidos. Así, una actualización interna de la base de datos no tiene por qué provocar fallos en todas las aplicaciones conectadas al mismo tiempo.

Proteger conjuntamente el gateway, las identidades y el backend

En el gateway pueden implementarse reglas centrales de autenticación, limitación de volumen y enrutamiento. No obstante, la autorización de negocio debe comprobarse en el servicio responsable: un cliente correctamente autenticado no debe poder leer automáticamente los registros de otro cliente. Por eso analizamos toda la cadena de la solicitud.

Para la operación, acordamos presupuestos de tiempo de respuesta, tiempos de espera y el tratamiento de los reintentos. Los identificadores de correlación conectan los registros de varios sistemas sin registrar de forma indiscriminada el contenido sensible de las solicitudes. Un acceso para desarrolladores con ejemplos y un entorno de pruebas adecuado ayuda a los socios a detectar errores antes de la conexión en producción.

Escenario de proyecto ilustrativo

Cómo ayuda el servicio en el día a día.

Ejemplo: los socios comerciales deben poder consultar el estado de sus pedidos. Ponemos a disposición una API delimitada, asignamos los accesos a la organización correspondiente y protegemos el ERP frente a una carga no controlada. Los cambios de estado internos se traducen en respuestas externas estables.

Este ejemplo explica un posible desarrollo y no constituye una referencia de cliente.

Antes del primer paso

Sus preguntas sobre Gestión de API.

¿Basta un gateway de API para la seguridad?

No. Complementa la comprobación de seguridad de la aplicación. Los permisos de negocio y el procesamiento seguro de los datos deben implementarse en los servicios responsables.

¿Pueden los socios externos recibir un entorno de pruebas?

Sí, si se acuerdan el alcance y el acceso a los datos. Planificamos medios de acceso independientes, datos de prueba adecuados y una vía de aprobación para producción.

¿Qué debemos saber sobre «Gestión de API»?

Los socios y las aplicaciones necesitan interfaces en cuyo comportamiento puedan confiar. Diseñamos los contratos de API, configuramos el acceso y la protección en el gateway, y organizamos las versiones, la documentación y las aprobaciones durante todo el ciclo de vida.

¿Qué servicios incluye «Gestión de API»?

Guía de API con convenciones de nomenclatura, formatos de error, versionado y requisitos de seguridad Catálogo de interfaces con especificación OpenAPI y responsable por API Creación del gateway con Kong, Apigee o Azure API Management, conectado a su gestión de identidades mediante OAuth 2.0 y OpenID Connect Portal para socios y desarrolladores con gestión de accesos, claves e informes de uso Ciclo de vida con proceso de aprobación, retirada de versiones antiguas y notificaciones de cambios

¿Qué resultados obtenemos con «Gestión de API»?

Guía de API y catálogo de interfaces Gateway de API operativo conectado a la gestión de identidades Portal para desarrolladores con documentación por API

¿Cómo ayuda OTOKO® con «Diseñar un contrato utilizable»?

Empezamos con los procesos de los sistemas conectados: ¿qué datos necesitan, qué estados pueden modificar y cómo detectan los errores? REST, GraphQL o gRPC se eligen según el caso de uso. La descripción utiliza el formato adecuado para el protocolo, por ejemplo OpenAPI para las API HTTP correspondientes. Además de la carga útil, se definen la paginación, los límites de tiempo, las respuestas de error y el comportamiento ante reintentos. Los ejemplos y los casos de prueba ayudan a los equipos consumidores a integrar la interfaz antes de la aprobación para producción.

¿Qué aspectos son importantes para «El gateway y la aplicación asumen comprobaciones distintas»?

Un gateway puede gestionar los accesos, limitar las solicitudes y aplicar reglas técnicas. Además, debe ser el servicio responsable quien decida si un usuario concreto puede leer un pedido determinado. Planificamos la comprobación de tokens, las identidades de servicio, la asignación de inquilinos y el registro a lo largo de este límite. En las llamadas de escritura se define cómo se tratan las solicitudes repetidas. Las versiones antiguas reciben un proceso de retirada claro, para que los cambios no interrumpan de forma inesperada las conexiones con los socios.

¿Qué debemos saber sobre «Realizar la aceptación con los consumidores»?

Las pruebas de contrato comprueban la estructura acordada; las pruebas de integración y de carga cubren además el comportamiento. Probamos los accesos denegados, las entradas no válidas y los tiempos de espera agotados, así como las llamadas correctas. El traspaso incluye la especificación, la configuración del gateway y las responsabilidades. Para empezar necesitamos los consumidores típicos, las hipótesis de carga y los procesos de negocio que la API debe hacer posibles.

¿Cómo ayuda OTOKO® con «Operar las interfaces como un acceso controlado a sus sistemas.»?

Diseñamos las API de forma que los equipos internos y los socios externos puedan utilizarlas con fiabilidad. Esto incluye un contrato comprensible, permisos de acceso claros y una operación que gestiona de forma visible los errores y la sobrecarga.

¿Cómo se comprueban los resultados de «Operar las interfaces como un acceso controlado a sus sistemas.»?

Los accesos no autorizados a objetos se prueban de forma explícita. El contrato de la API y su implementación coinciden en los casos acordados. La sobrecarga y los fallos generan respuestas documentadas.

¿Cómo puede ser «Operar las interfaces como un acceso controlado a sus sistemas.» en la práctica?

Ejemplo: los socios comerciales deben poder consultar el estado de sus pedidos. Ponemos a disposición una API delimitada, asignamos los accesos a la organización correspondiente y protegemos el ERP frente a una carga no controlada. Los cambios de estado internos se traducen en respuestas externas estables.

¿Qué aspectos son importantes para «De la función de negocio a un contrato de API estable»?

Una API debería ofrecer una función de negocio comprensible y no exponer sin filtrar las tablas de un sistema interno. Definimos recursos, acciones, campos obligatorios y respuestas de error junto con los equipos consumidores. Los datos de ejemplo y una descripción legible por máquina facilitan la integración; las reglas de negocio quedan documentadas de forma explícita. Los cambios se evalúan según su impacto. Un campo opcional adicional se trata de forma distinta a un nuevo valor obligatorio o a un cambio de significado. Planificamos el versionado, los plazos de transición y la comunicación a los usuarios conocidos. Así, una actualización interna de la base de datos no tiene por qué provocar fallos en todas las aplicaciones conectadas al mismo tiempo.

¿Qué debemos saber sobre «Proteger conjuntamente el gateway, las identidades y el backend»?

En el gateway pueden implementarse reglas centrales de autenticación, limitación de volumen y enrutamiento. No obstante, la autorización de negocio debe comprobarse en el servicio responsable: un cliente correctamente autenticado no debe poder leer automáticamente los registros de otro cliente. Por eso analizamos toda la cadena de la solicitud. Para la operación, acordamos presupuestos de tiempo de respuesta, tiempos de espera y el tratamiento de los reintentos. Los identificadores de correlación conectan los registros de varios sistemas sin registrar de forma indiscriminada el contenido sensible de las solicitudes. Un acceso para desarrolladores con ejemplos y un entorno de pruebas adecuado ayuda a los socios a detectar errores antes de la conexión en producción.

¿Cómo ayuda OTOKO® con «Evaluación»?

Mapa de sistemas, flujos de datos, cuellos de botella Área de negocio, operación de TI, arquitectura, arquitecto de integración de OTOKO® Inventario de interfaces, riesgos evaluados, casos de integración priorizados

¿Qué aspectos son importantes para «Concepto»?

Arquitectura de integración, catálogo de interfaces, modelo de operación Arquitectura, seguridad de la información, protección de datos, área de negocio Arquitectura objetivo, propiedad de los datos por objeto, requisitos de seguridad, modelo de operación

Su proyecto

¿Qué tarea desea resolver?

Describa su situación de partida y el resultado que desea. El servicio seleccionado se incluirá en la solicitud de contacto.

Nuestros socios

  • Microsoft
  • Microsoft Azure
  • Amazon AWS
  • Google Cloud
  • Thales Group
  • Arrow ECS
  • Vodafone
  • IBM
  • Veeam
  • Atlassian
  • JetBrains
  • NinjaOne
  • OPSWAT
  • Utimaco
  • Eviden

Accesibilidad

Adapta la visualización a tus necesidades.

Esta página aún no tiene una versión en lenguaje sencillo.

Actualmente, los ajustes solo se aplican a esta visita. Puedes permitir que se guarden de forma permanente en Configuración de cookies.