Conceptos de API

Esta sección explica los conceptos técnicos y las convenciones fundamentales que se aplican a todas las APIs de YAPU. Si eres nuevo integrando con YAPU, lee esta página antes de pasar a la autenticación o a las especificaciones técnicas.

Descripción general de la arquitectura

Las APIs de YAPU siguen la arquitectura REST (Representational State Transfer). Esto significa:

• Las APIs están organizadas en torno a recursos y se accede a ellos mediante verbos HTTP estándar (GET, POST, etc.)
• Cada solicitud y respuesta utiliza JSON como formato de datos
• Toda la comunicación ocurre sobre HTTPS — sin excepciones
• Cada llamada a la API es una única solicitud JSON, no en lotes ni en streaming

Esto hace que las APIs de YAPU sean compatibles con cualquier lenguaje de programación o plataforma moderna que pueda realizar solicitudes HTTPS y parsear JSON.

Requisitos de transporte y seguridad

Solo HTTPS

Toda la comunicación con la API de YAPU debe realizarse sobre HTTPS. Las solicitudes enviadas mediante HTTP simple no serán aceptadas. No hay excepciones a este requisito.

Comunicación por IP dinámica

YAPU soporta comunicación por IP dinámica. Esto significa que la dirección IP de tu integración no necesita estar registrada ni incluida en una lista blanca con antelación.

:::warning Limitación importante YAPU no soporta comunicación por IP estática. Si tu infraestructura requiere una dirección IP fija e incluida en lista blanca para acceder a servicios externos, esto debe discutirse con tu contacto en YAPU antes de que comience la fase de especificación. :::

Formato de solicitudes y respuestas

Estructura de la solicitud

Cada llamada a la API de YAPU se realiza como una única solicitud JSON. No existen solicitudes multiparte ni carga de archivos en los bundles de API estándar.

Las solicitudes siguen las convenciones estándar de HTTPS:

• Un verbo HTTP definido (por ejemplo, POST, GET)
• Cabeceras de solicitud requeridas, incluyendo la autenticación
• Un cuerpo JSON donde corresponda

Las estructuras exactas de solicitud están definidas por bundle de API en la documentación técnica proporcionada durante la fase de especificación.

Estructura de la respuesta

YAPU devuelve las respuestas en formato JSON. Los datos de respuesta se proporcionan generalmente como valores de tipo string — es responsabilidad del cliente convertir estos strings en los tipos de datos adecuados para sus propios sistemas.

nota

La conversión de los datos salientes de YAPU desde formato string a tu propio modelo de datos es responsabilidad del cliente y debe contemplarse dentro del alcance de tu desarrollo.

Códigos de estado HTTP

Las APIs de YAPU utilizan códigos de estado HTTP estándar para comunicar el resultado de una solicitud:

Código	Significado
200 OK	Solicitud realizada correctamente
201 Created	Recurso creado correctamente
400 Bad Request	La solicitud estaba malformada o le faltaban campos requeridos
401 Unauthorized	Error de autenticación o token ausente
403 Forbidden	Autenticado pero sin autorización para esta acción
404 Not Found	El recurso no existe
422 Unprocessable Entity	La solicitud era válida pero no pudo procesarse
500 Internal Server Error	Error inesperado en el lado de YAPU

Convenciones de formato de datos

Datos entrantes (del cliente a YAPU)

Los datos enviados desde tu sistema a YAPU deben seguir los formatos específicos de YAPU. Estos formatos se definen para cada bundle de API en la documentación técnica proporcionada durante la fase de especificación.

El incumplimiento del formato correcto producirá un error en la solicitud. YAPU no transforma ni reformatea silenciosamente los datos entrantes.

Datos salientes (de YAPU al cliente)

Los datos devueltos por YAPU se proporcionan como valores de tipo string. Tu sistema es responsable de interpretar y convertir estos datos en los formatos que tu aplicación requiere.

Entornos

YAPU proporciona dos entornos para la integración:

Entorno	Propósito
Staging	Desarrollo y pruebas de integración — no apto para uso en producción
Producción	Sistema en vivo — solo se utiliza tras completar las pruebas conjuntas en staging

Las URLs y credenciales específicas de cada entorno son proporcionadas por tu contacto en YAPU durante la fase de especificación y no se publican en este portal.

info

Completa siempre las pruebas en staging antes de desplegar en producción. Consulta Pruebas y puesta en producción para conocer el proceso completo de pruebas.

Resumen

Concepto	Valor
Arquitectura	REST
Formato de datos	JSON
Transporte	Solo HTTPS
Comunicación IP	Dinámica (IP estática no compatible)
Tipo de solicitud	Una única solicitud JSON por llamada
Tipo de datos salientes	String (el cliente convierte)
Formato de datos entrantes	Específico de YAPU (definido por bundle)
Códigos de estado HTTP	Estándar