> For the complete documentation index, see [llms.txt](https://docs.editran.onesait.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.editran.onesait.com/documentacion-editran/connect-3.2/api.md).

# API Restful Editran

El módulo de **Interoperabilidad** de Editran Connect permite integrar funcionalidades clave del sistema en aplicaciones externas mediante una API **RESTful** segura y estructurada.

Está especialmente orientado a escenarios donde se necesita realizar tareas de Editran desde sistemas de gestión como **ERP**, **CRM**, plataformas de tramitación documental o cualquier software corporativo. Esto permite automatizar flujos de trabajo y simplificar la operativa diaria sin necesidad de acceder manualmente a la interfaz web de Connect.

Las operaciones disponibles permiten, entre otras funcionalidades (descritas en secciones posteriores):

* Iniciar transmisiones.
* Consultar el estado de envíos o recepciones.
* Gestionar ficheros asociados a los canales.

Esta API está diseñada bajo principios REST, utilizando llamadas HTTP estándar (`GET`, `POST`, `PUT`, etc.) y respuestas en formato JSON, lo que facilita su adopción en entornos modernos y heterogéneos.

El uso del módulo requiere **licencia habilitada** y puede estar sujeto a mecanismos de autenticación y control de acceso configurados en el sistema.

***

> ℹ️ *Nota:* Este módulo no sustituye la interfaz de usuario, sino que la complementa en entornos donde Editran Connect actúa como sistema interoperable dentro de un ecosistema IT más amplio.

Las siguientes secciones detallan las operaciones disponibles, estructuras de petición y respuesta, requisitos de autenticación, y ejemplos prácticos de uso.

***

> ⚠️ **Aviso importante:**\
> El uso del módulo de Interoperabilidad (Web API) está sujeto a las condiciones de licenciamiento contratadas con la plataforma Editran Connect.
>
> Si tiene dudas sobre si su instalación dispone de este módulo habilitado o sobre cómo activarlo, puede contactar con el equipo de soporte comercial en:\
> [**editran@minsait.com**](mailto:editran@minsait.com)

## Ejemplos

A continuación puedes encontrar una serie de ejemplos de uso que pueden ayudarte con la implementación de los web services de **Editran**

{% content-ref url="/pages/zCNJyCX4p6TUqhPH4TYm" %}
[01 - ejemplo script - upload-send](/documentacion-editran/connect-3.2/api/ejemplos/01_upload-send.md)
{% endcontent-ref %}

Ejemplo en Powershell con el que modificamos el fichero/directorio de emisión un canal de emisión/bidireccional y realizamos una emisión.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.editran.onesait.com/documentacion-editran/connect-3.2/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.