> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Referencia de la API

> Referencia de la API REST de FlexiCapture for Invoices Cloud: endpoints y recursos para archivos, tareas, conjuntos de datos de unidades de negocio y proveedores, y entrenamiento.

La API de ABBYY FlexiCapture for Invoices Cloud se basa en [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). La API le permite acceder a los recursos del servicio ABBYY FlexiCapture Cloud. Después de registrarse y obtener el encabezado de autenticación, puede realizar solicitudes a la API de ABBYY FlexiCapture for Invoices Cloud.

La API utiliza funcionalidades HTTP integradas, como la autenticación HTTP y los verbos HTTP, que son compatibles con los clientes HTTP estándar.

El [portal web de ABBYY FlexiCapture Cloud](https://flexicapture.com) incluye la definición de la API en formato Swagger. Puede usarla para generar código de cliente en el lenguaje que utilice para su proyecto mediante herramientas específicas, por ejemplo [Swagger Editor](https://editor.swagger.io/).

<div id="api-endpoint">
  ## Endpoint de la API
</div>

<a id="icaas-supported-countries" />

```text theme={null}
https://api-{location-id}.flexicapture.com
```

Reemplace `{location-id}` por una de las ubicaciones compatibles:

* `us`: USA y Canadá
* `au`: Australia
* `eu`: los países de la Unión Europea

<div id="rest-resources">
  ## Recursos REST
</div>

Las rutas de endpoint que se muestran a continuación son relativas al endpoint de la API descrito anteriormente.

<div id="v2file">
  ### v2.file
</div>

| Método                                                                         | Endpoint                         | Descripción                             |
| ------------------------------------------------------------------------------ | -------------------------------- | --------------------------------------- |
| [Cargar](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-upload-file)        | `POST /v2/file`                  | Carga uno o varios archivos en la nube. |
| [Descargar](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-download-file)   | `GET /v2/file/{id}/{token}`      | Descarga un archivo de la nube.         |
| [Obtener](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-file-metadata) | `GET /v2/file/{id}/{token}/info` | Devuelve los metadatos del archivo.     |
| [Eliminar](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-file)      | `DELETE /v2/file/{id}/{token}`   | Elimina un archivo de la nube.          |

<div id="v2task">
  ### v2.task
</div>

| Método                                                                    | Endpoint                         | Descripción                                |
| ------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------ |
| [Ejecutar](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-run-task)    | `POST /v2/task/capture/invoices` | Ejecuta una tarea de captura de facturas.  |
| [Obtener](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-task)     | `GET /v2/task/{id}`              | Obtiene información de la tarea por su ID. |
| [Eliminar](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-task) | `DELETE /v2/task/{id}`           | Elimina los datos de la tarea por su ID.   |

<div id="v2dataset">
  ### v2.dataset
</div>

| Método                                                                                                      | Endpoint                                                           | Descripción                                                                         |
| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------- |
| [Crear unidad de negocio](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-bu)                      | `POST /v2/dataset/businessunits`                                   | Crea una lista de unidades de negocio.                                              |
| [Actualizar unidad de negocio](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-bu)                 | `PUT /v2/dataset/businessunits`                                    | Actualiza la información de las unidades de negocio en el conjunto de datos.        |
| [Obtener unidad de negocio](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-bu)                       | `GET /v2/dataset/businessunits/{region}`                           | Devuelve una lista de unidades de negocio de la región especificada.                |
| [Eliminar unidad de negocio por región](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-reg) | `DELETE /v2/dataset/businessunits/{region}`                        | Elimina del conjunto de datos las unidades de negocio de la región especificada.    |
| [Eliminar unidad de negocio por ID](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-id)      | `DELETE /v2/dataset/businessunit/{region}/{externalId}`            | Elimina del conjunto de datos una unidad de negocio con el ID externo especificado. |
| [Crear proveedor](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-vendor)                          | `POST /v2/dataset/vendors`                                         | Crea una lista de proveedores.                                                      |
| [Actualizar proveedor](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-vendor)                     | `PUT /v2/dataset/vendors`                                          | Actualiza la información de los proveedores en el conjunto de datos.                |
| [Obtener proveedor](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-vendor)                           | `GET /v2/dataset/vendors/{region}`                                 | Devuelve una lista de proveedores de la región especificada.                        |
| [Eliminar proveedor por región](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-reg)     | `DELETE /v2/dataset/vendors/{region}`                              | Elimina del conjunto de datos los proveedores de la región especificada.            |
| [Eliminar proveedor por ID](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-id)          | `DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}` | Elimina del conjunto de datos un proveedor con el ID externo especificado.          |

<div id="v2training">
  ### v2.training
</div>

| Método                                                                    | Endpoint                                    | Descripción                                    |
| ------------------------------------------------------------------------- | ------------------------------------------- | ---------------------------------------------- |
| [Entrenar](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-train-model) | `POST /v2/training`                         | Entrena un modelo de captura de datos.         |
| [Layout](/es/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-layout)    | `GET /v2/training/layout/{taskId}/{fileId}` | Obtiene la estructura de los datos capturados. |