Référence de l’API

L’API Cloud ABBYY FlexiCapture for Invoices repose sur REST. 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 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.

Point de terminaison de l’API

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

Ressources REST

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

v2.file

Méthode	Point de terminaison	Description
Téléverser	`POST /v2/file`	Téléverse un ou plusieurs fichiers vers le cloud.
Télécharger	`GET /v2/file/{id}/{token}`	Télécharge un fichier depuis le cloud.
Obtenir	`GET /v2/file/{id}/{token}/info`	Renvoie les métadonnées du fichier.
Delete	`DELETE /v2/file/{id}/{token}`	Supprime un fichier du cloud.

v2.task

Méthode	Point de terminaison	Description
Exécuter	`POST /v2/task/capture/invoices`	Exécuter une tâche de capture de factures.
Récupérer	`GET /v2/task/{id}`	Récupérer les informations d’une tâche à l’aide de son ID.
Delete	`DELETE /v2/task/{id}`	Supprimer les données d’une tâche à l’aide de son ID.

v2.dataset

Méthode	Point de terminaison	Description
Créer une unité commerciale	`POST /v2/dataset/businessunits`	Crée une liste d’unités commerciales.
Mettre à jour une unité commerciale	`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	`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	`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	`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	`POST /v2/dataset/vendors`	Crée une liste de fournisseurs.
Mettre à jour un fournisseur	`PUT /v2/dataset/vendors`	Met à jour les informations sur les fournisseurs dans le jeu de données.
Récupérer un fournisseur	`GET /v2/dataset/vendors/{region}`	Renvoie une liste de fournisseurs correspondant à la région spécifiée.
Supprimer un fournisseur par région	`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	`DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}`	Supprime du jeu de données un fournisseur avec l’ID externe spécifié.

v2.training

Méthode	Point de terminaison	Description
Entraîner	`POST /v2/training`	Entraîner un modèle de capture de données.
Layout	`GET /v2/training/layout/{taskId}/{fileId}`	Récupérer la structure des données capturées.

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

Point de terminaison de l’API

Ressources REST

v2.file

v2.task

v2.dataset

v2.training

​Point de terminaison de l’API

​Ressources REST

​v2.file

​v2.task

​v2.dataset

​v2.training

Point de terminaison de l’API

Ressources REST

v2.file

v2.task

v2.dataset

v2.training