# EDICOM iPaaS REST API — Documentación Descargada
Fuente: https://ipaas-docs.edicomgroup.com/docs/manual/
Fecha de descarga: 2026-07-23

---

## Introducción

Esta es la referencia de la API REST de EDICOM EIPAAS.

## Seguridad / Autenticación

La API REST de EIPAAS utiliza autenticación **Bearer** (también llamada autenticación por token).
Este esquema de autenticación HTTP implica tokens de seguridad llamados *bearer tokens*.

El cliente DEBE enviar este token en la cabecera `Authorization` al hacer peticiones a los recursos protegidos:

```
Authorization: Bearer <token>
```

Hay dos opciones para obtener el bearer token:
- **EDICOM Accounts** (ver: https://ipaas-docs.edicomgroup.com/docs/manual/auth/accounts-token)
- **EIPAAS API Keys** (ver: https://ipaas-docs.edicomgroup.com/docs/manual/auth/ipaas-api-token)

---

## Cabeceras Obligatorias

Deben incluirse en **cada** petición a la API:

| Cabecera | Descripción |
|---|---|
| `Authorization` | `Bearer <token>` — Token de autenticación |
| `X-Eipaas-Ds` | Datasource / Dominio EDICOM del cliente (ej. `ASPEDIXX`) |

### Ejemplo de petición completa

```http
GET /api/v1/domain/DOMAIN HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...
X-Eipaas-Ds: ASPEDIXX
Host: ipaasgw.edicomgroup.com
```

Ejemplo cURL:
```bash
curl 'https://ipaasgw.edicomgroup.com/api/v1/domain/DOMAIN' -i -X GET \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...' \
  -H 'X-eipaas-ds: ASPEDIXX'
```

---

## Códigos de Estado HTTP

| Código | Descripción |
|---|---|
| `200 OK` | Respuesta estándar para peticiones HTTP exitosas |
| `201 Created` | La petición fue completada y resultó en un nuevo recurso |
| `204 No Content` | El servidor procesó la petición correctamente pero no devuelve contenido |
| `400 Bad Request` | Error de cliente (sintaxis malformada, petición inválida) |
| `401 Unauthorized` | No se incluyó token de autenticación o expiró |
| `403 Forbidden` | El cliente no tiene permisos para acceder al recurso |
| `404 Not Found` | El recurso solicitado no se encontró |
| `409 Conflict` | La petición no pudo completarse por conflicto con el estado actual del recurso |
| `500 Internal Error` | Error interno del servidor |

---

## Endpoints Principales

Basado en el listado oficial de URLs de la API (https://ipaas-docs.edicomgroup.com/):

| URL Documentación | Descripción |
|---|---|
| `/docs/openapi/eipaas-server-api` | Referencia OpenAPI del servidor EIPAAS |
| `/docs/openapi/application` | API de Aplicación |
| `/docs/openapi/get-messages` | **Obtener mensajes pendientes (ORDERS incoming)** |
| `/docs/openapi/publish` | **Publicar mensajes (DESADV/INVOIC outgoing)** |
| `/docs/openapi/publish-raw` | Publicar mensajes en formato raw |
| `/docs/openapi/subscription` | Suscripciones a mensajes |
| `/docs/openapi/confirm-subscription-by-application` | Confirmar suscripción por aplicación |
| `/docs/openapi/subscriptions-list-by-application` | Listar suscripciones por aplicación |
| `/docs/openapi/subs-and-multi-transform` | Suscripción + transformación múltiple |
| `/docs/openapi/subs-and-report` | Suscripción + informe |
| `/docs/openapi/subs-and-transform` | Suscripción + transformación |
| `/docs/openapi/transform-and-publish` | Transformar y publicar |
| `/docs/openapi/transformation` | Transformaciones de documentos |
| `/docs/openapi/subscriptions-list-by-domain` | Suscripciones por dominio |
| `/docs/openapi/subscription-pending-by-schema` | Suscripciones pendientes por esquema |
| `/docs/openapi/subscription-pending` | **Mensajes pendientes en suscripción** |
| `/docs/openapi/confirm-subscription` | **Confirmar suscripción/mensaje** |
| `/docs/openapi/subscription-reject` | Rechazar suscripción |

---

## URL Base de la API

```
https://ipaasgw.edicomgroup.com
```

---

## Flujo General de Integración

### Mensajes Entrantes (Inbound - Recibir ORDERS/Pedidos)
1. La plataforma EDICOM recibe el mensaje EDI del partner comercial (cliente/cadena)
2. Lo convierte al formato canónico interno del proyecto
3. Nuestro sistema consulta los mensajes pendientes mediante `GET /api/v1/messages/pending` (o endpoint específico del proyecto)
4. Descarga y procesa cada mensaje
5. Confirma la recepción mediante `POST /api/v1/messages/confirm`

### Mensajes Salientes (Outbound - Enviar DESADV/INVOIC)
1. Nuestro sistema genera el contenido del albarán o factura en formato canónico
2. Lo publica mediante `POST /api/v1/messages/publish` (o endpoint específico del proyecto)
3. La plataforma EDICOM lo convierte al estándar EDI requerido (EDIFACT UN/EDIFACT D96A o similar)
4. Lo transmite al partner comercial (cliente/cadena)

---

## Notas Importantes

> **IMPORTANTE**: Los endpoints específicos (`/api/v1/...`), el dominio del datasource (`X-Eipaas-Ds`),
> el esquema JSON exacto del payload y los datos de acceso deben solicitarse al
> **gestor de proyecto EDICOM** asignado a la implementación.
> La documentación pública describe el framework general; los detalles son específicos del tenant.

> **Formatos EDI**: EDICOM trabaja principalmente con estándar **UN/EDIFACT**:
> - Pedidos: `ORDERS D96A`
> - Albaranes/Avisos de expedición: `DESADV D96A`
> - Facturas: `INVOIC D96A`