OpenAPI

Además de consumir la API mediante el servicio web o el cliente dll, es posible utilizar la especificación OpenAPI (v3) publicada por SDH para integrarse con el DeCA.

La especificación está disponible en formato JSON en la siguiente URL:

https://decatest.solmicrosdh.com/openapi/v1.json

¿Para qué sirve?

Esta especificación describe de forma formal y siempre actualizada todos los endpoints, parámetros, esquemas de petición/respuesta y códigos de estado de la API REST del DeCA. Se puede utilizar, entre otras cosas, para:

• Importarla en herramientas como Postman o Insomnia para explorar y probar la API de forma interactiva.
• Generar automáticamente clientes (SDK) en el lenguaje de programación deseado mediante generadores de código compatibles con OpenAPI, como OpenAPI Generator o NSwag.
• Validar que las peticiones y respuestas de una integración cumplen con el contrato definido por SDH.
• Mantener sincronizada la documentación técnica de la integración con la versión real desplegada del servicio.

Endpoints incluidos

La especificación recoge los siguientes endpoints descritos en la documentación de la API DeCA:

• POST /api/control-documents - Crear nuevo DeCA.
• PUT /api/control-documents/{id} - Actualizar DeCA.
• DELETE /api/control-documents/{id} - Eliminar DeCA.
• POST /api/control-documents/{id}/resend-notification - Reenviar DeCA.

Consideraciones

• La especificación OpenAPI no incluye el esquema de seguridad, por lo que sigue siendo necesario cumplir con los requisitos de Autenticación e incluir la cabecera CompanyId, tal y como se indica en el servicio web.
• Al tratarse de un documento generado automáticamente a partir del código del servicio, puede evolucionar entre versiones; se recomienda descargarla periódicamente en lugar de mantener una copia estática en el proyecto de integración.