Documentation de data2check – Utilisation de l'API

1. Objectif

Même sans utiliser l'interface Web gratuite data2check, les documents peuvent être vérifiés. Avec l'aide d'une API REST simple, les vérifications disponibles peuvent être intégrées dans d'autres services, tels que systèmes de gestion de contenu.

2. Création d'un jeton API

Pour pouvoir utiliser la API REST, un soi-disant "jeton API" doit d'abord être créé. Dans ce but, vous devez sélectionner »Jetons API« dans la gestion des utilisateurs de data2check, sur le côté droit du menu principal (voir figure 1, cercle orange).

La gestion des utilisateurs data2check - Jetons API

Figure 1: La gestion des utilisateurs data2check - Les jetons API.

Maintenant, l'administration des jetons API apparaît. Veuillez cliquer sur le bouton vert »Créer un jeton API« (voir figure 2), pour créer un jeton.

Administration des jetons API - Création d'un jeton API

Figure 2: Administration des jetons API - Création d'un jeton API.

Sur la page suivante, les jetons API peuvent être affichés, renouvelés (bouton vert »Renouveler le jeton API«) et supprimés (bouton rouge »Supprimer le jeton API«). Par utilisateur, un seul jeton API à la fois est actif et peut être utilisé pour toute configuration disponible (voir figure 3).

Le jeton API actuel

Figure 3: Le jeton API actuel (représentation exemplaire).

NOTEZ S'IL VOUS PLAÎT: En général, un jeton API n'a qu'un temps de fonctionnement limité et doit donc être renouvelé après l'expiration. Normalement, le temps de fonctionnement standard est d'un mois.

3. Vérification d'un document

Avec l'aide de cette API, les documents Word et InDesign peuvent être vérifiés. La sortie de chaque appel comprend exactement un document de résultat. Afin de simplifier la génération des URL requises, l'administration des jetons API offre un aperçu de toutes les configurations disponibles et aussi les URL REST correspondantes. Dans cette URL, le jeton API correct est déjà inclus. Après avoir sélectionné le type de résultat souhaité, l'URL peut simplement être copiée et insérée dans votre propre système.

Les configurations (éventuellement) disponibles pour vérifier un document sont listées chronologiquement avec un fond gris. En cliquant sur l'une des configurations, les détails suivants sont fournis: le texte de description pour la configuration individuelle (Description), une liste déroulante contenant les types possibles de documents de sortie (Type) ainsi que l'URL REST correspondant au format de sortie sélectionné (voir figure 4).

Les détails de la configuration sélectionnée

Figure 4: Les détails de la configuration sélectionnée (représentation exemplaire).

Selon le document de résultat requis (la version commentée du document, la version XML du document, le rapport de vérification XML ou le rapport de vérification formaté), il doit être sélectionné dans la liste déroulante à côté de »Type« (voir figure 5).

Sélection du format de sortie souhaité

Figure 5: Sélection du format de sortie souhaité.

Plus informations sur les documents de résultats disponibles après avoir vérifié un document peuvent être trouvées sous Vérification d'un document Word - 3.2 Les documents de sortie pour Word, sous Vérification d'un document InDesign - 3.2 Les documents de sortie ainsi que sous Vérification d'InDesign-a-EPUB - 2.2 Les documents de sortie pour InDesign.

Pour vérifier un document, une demande POST au format multipart/form-data est envoyée à l'URL correspondante. Le fichier à vérifier doit être joint en tant que paramètre avec le nom file. Le traitement est effectué de manière synchrone, ce qui signifie que la demande s'exécute tant que la vérification est terminée, puis renvoie le format de sortie sélectionné comme un résultat. Selon la charge du service data2check, ce processus peut prendre quelques secondes.

Exemple: En utulisant curl, un document Word pourrait être vérifié comme suit:

curl -X POST -o resultat.docx -F file=@exemple.docx "http://service.data2check.de/api/doc/docx?wfid=CONFIGURATION-ID&tokenid=TOKEN"

4. Limites d'utilisation

Par utilisateur, un seul document à la fois peut être vérifié. Cela doit être pris en compte lors de l'intégration de l'API dans ses propres services. En cas d'utilisation excessive, data2check se réserve le droit d'introduire un contingent d'utilisation limité. Les conditions spéciales, comme par exemple une période de validité prolongée des jetons d'API, sont possibles dans des cas individuels après consultation. Nos informations de contact se trouvent sous Contact.

Copyright © 2018 data2check, tous droits résérvés

Conditions générales | Mentions légales | Avis de confidentalité