> 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-en/api.md).

# Editran RESTful API

The module of **Interoperability** of Editran Connect allows key system functionalities to be integrated into external applications via a **RESTful** secure and structured API.

It is especially aimed at scenarios where Editran tasks need to be performed from management systems such as **ERP**, **CRM**, document processing platforms, or any corporate software. This makes it possible to automate workflows and simplify daily operations without the need to manually access the Connect web interface.

The available operations allow, among other functionalities (described in later sections):

* Start transmissions.
* Check the status of sends or receipts.
* Manage files associated with the channels.

This API is designed under REST principles, using standard HTTP calls (`GET`, `POST`, `PUT`, etc.) and responses in JSON format, which facilitates its adoption in modern and heterogeneous environments.

Using the module requires **an enabled license** and may be subject to authentication and access control mechanisms configured in the system.

***

> ℹ️ *Note:* This module does not replace the user interface, but rather complements it in environments where Editran Connect acts as an interoperable system within a broader IT ecosystem.

The following sections detail the available operations, request and response structures, authentication requirements, and practical usage examples.

***

> ⚠️ **Important notice:**\
> The use of the Interoperability module (Web API) is subject to the licensing terms contracted with the Editran Connect platform.
>
> If you have any questions about whether your installation has this module enabled or how to activate it, you can contact the commercial support team at:\
> [**editran@minsait.com**](mailto:editran@minsait.com)

## Examples

Below you can find a series of usage examples that may help you with the implementation of the web services of **Editran**

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

PowerShell example with which we modify the output file/directory of a sending/bidirectional channel and perform a transmission.


---

# 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-en/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.