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

# Référence de l’API

> Référence de l’API REST FlexiCapture for Invoices Cloud : points de terminaison et ressources pour les fichiers, les tâches, les jeux de données d’unités commerciales et de fournisseurs, ainsi que l’entraînement.

L’API Cloud ABBYY FlexiCapture for Invoices repose sur [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). L’API vous permet d’accéder aux ressources du service Cloud ABBYY FlexiCapture. Une fois inscrit et muni de l’en-tête d’authentification, vous pouvez envoyer des requêtes à l’API Cloud ABBYY FlexiCapture for Invoices.

L’API utilise des fonctionnalités HTTP intégrées, comme l’authentification HTTP et les verbes HTTP, qui sont prises en charge par les clients HTTP standard.

Le [portail web ABBYY FlexiCapture Cloud](https://flexicapture.com) inclut la définition de l’API au format Swagger. Vous pouvez l’utiliser pour générer du code client dans le langage utilisé pour votre projet à l’aide d’outils spécialisés, par exemple [Swagger Editor](https://editor.swagger.io/).

<div id="api-endpoint">
  ## Point de terminaison de l’API
</div>

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

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

Remplacez `{location-id}` par l’une des régions prises en charge :

* `us` : USA et Canada
* `au` : Australie
* `eu` : les pays de l’Union européenne

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

Les chemins des points de terminaison ci-dessous sont relatifs au point de terminaison de l’API décrit ci-dessus.

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

| Méthode                                                                        | Point de terminaison             | Description                                       |
| ------------------------------------------------------------------------------ | -------------------------------- | ------------------------------------------------- |
| [Téléverser](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-upload-file)    | `POST /v2/file`                  | Téléverse un ou plusieurs fichiers vers le cloud. |
| [Télécharger](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-download-file) | `GET /v2/file/{id}/{token}`      | Télécharge un fichier depuis le cloud.            |
| [Obtenir](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-file-metadata) | `GET /v2/file/{id}/{token}/info` | Renvoie les métadonnées du fichier.               |
| [Delete](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-file)        | `DELETE /v2/file/{id}/{token}`   | Supprime un fichier du cloud.                     |

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

| Méthode                                                                 | Point de terminaison             | Description                                                |
| ----------------------------------------------------------------------- | -------------------------------- | ---------------------------------------------------------- |
| [Exécuter](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-run-task)  | `POST /v2/task/capture/invoices` | Exécuter une tâche de capture de factures.                 |
| [Récupérer](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-task) | `GET /v2/task/{id}`              | Récupérer les informations d’une tâche à l’aide de son ID. |
| [Delete](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-task) | `DELETE /v2/task/{id}`           | Supprimer les données d’une tâche à l’aide de son ID.      |

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

| Méthode                                                                                                          | Point de terminaison                                               | Description                                                                     |
| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------- |
| [Créer une unité commerciale](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-bu)                       | `POST /v2/dataset/businessunits`                                   | Crée une liste d'unités commerciales.                                           |
| [Mettre à jour une unité commerciale](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-bu)               | `PUT /v2/dataset/businessunits`                                    | Met à jour les informations sur les unités commerciales dans le jeu de données. |
| [Récupérer une unité commerciale](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-bu)                      | `GET /v2/dataset/businessunits/{region}`                           | Renvoie une liste d'unités commerciales correspondant à la région spécifiée.    |
| [Supprimer une unité commerciale par région](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-reg) | `DELETE /v2/dataset/businessunits/{region}`                        | Supprime du jeu de données les unités commerciales de la région spécifiée.      |
| [Supprimer une unité commerciale par ID](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-id)      | `DELETE /v2/dataset/businessunit/{region}/{externalId}`            | Supprime du jeu de données une unité commerciale avec l'ID externe spécifié.    |
| [Créer un fournisseur](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-vendor)                          | `POST /v2/dataset/vendors`                                         | Crée une liste de fournisseurs.                                                 |
| [Mettre à jour un fournisseur](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-vendor)                  | `PUT /v2/dataset/vendors`                                          | Met à jour les informations sur les fournisseurs dans le jeu de données.        |
| [Récupérer un fournisseur](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-vendor)                         | `GET /v2/dataset/vendors/{region}`                                 | Renvoie une liste de fournisseurs correspondant à la région spécifiée.          |
| [Supprimer un fournisseur par région](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-reg)    | `DELETE /v2/dataset/vendors/{region}`                              | Supprime du jeu de données les fournisseurs de la région spécifiée.             |
| [Supprimer un fournisseur par ID](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-id)         | `DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}` | Supprime du jeu de données un fournisseur avec l'ID externe spécifié.           |

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

| Méthode                                                                    | Point de terminaison                        | Description                                   |
| -------------------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------- |
| [Entraîner](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-train-model) | `POST /v2/training`                         | Entraîner un modèle de capture de données.    |
| [Layout](/fr/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-layout)     | `GET /v2/training/layout/{taskId}/{fileId}` | Récupérer la structure des données capturées. |