L'API générale est conçue pour permettre de récupérer, répertorier, mettre à jour, créer et supprimer des entrées de données dans le système. Elle peut être utilisée pour automatiser des processus tels que la gestion des fournisseurs ou la création de designs.

Modèles et actions

Chaque type de données (par exemple, un cmp, un design, un fournisseur, etc.) est appelé un modèle ; chaque modèle propose plusieurs actions (get/list/update/…). Vous pouvez utiliser l'appel à info pour obtenir la spécification OpenAPI de tous les modèles et actions :

https://[API-Endpoint]/info

Veuillez noter que les appels non authentifiés vers le modèle d'informations entraîneront une spécification OpenAPI pour les actions non authentifiées. Afin d'obtenir tous les modèles et actions possibles pour votre compte, veuillez d'abord vous authentifier.

Structure des URL

Les appels à l'action suivent la structure suivante :

https://[API-Endpoint]/model/[MODELNAME]/[ACTIONNAME]

Exemple :

https://[API-Endpoint]/model/CMP/list

Outre les appels de modèle, il existe des appels à l'authentification et à la spécification OpenAPI :

https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/info

Structure générale du message

La communication s'effectue par l'échange de données JSON. Pour lancer une action, veuillez envoyer une requête POST avec les données JSON suivantes dans le corps HTTP :

{
  "accessType": 1,         // Access type (may be required for authentication calls)
  "lang":       1|2|3|..., // Language (optional)  
  "kmd":        "...",     // Authentication token (optional/required depending on context)  
  "key":        "..."      // Your API-Key (optional/required depending on context)
  // other fields might be required depending on context
}

Le contenu des données JSON peut varier en fonction de l'action à effectuer. Veuillez donc consulter la section Actions ici.

Selon la mise en œuvre du projet, un key clé peut être nécessaire pour certaines actions (par exemple, la création d'un nouvel utilisateur). Veuillez contacter votre chargé de compte afin de recevoir votre clé.

L'API répondra avec un corps JSON formaté comme suit :

{
  "status":     "...",  // Status: Success|Error 
  "statuscode": 0..999, // Status code
  "msg":        "...",  // Human readable status message
  "model":      "...",  // Context dependend. May return model type to be displayed or null
  "action":     "...",  // Action performed
  "data":        ...    // Type and content is depended on context  
}

Codes d'erreur

L'API utilisera les codes d'erreur suivants pour signaler les problèmes. Le code d'erreur est envoyé via la statuscode propriété de la réponse.

Types d'accès

En fonction de la structure de l'API, différents types d'accès existent (champ JSON « accessType »). Veuillez contacter votre gestionnaire de compte afin d'obtenir l'ID correspondant au type d'accès que vous pouvez utiliser.

Modèles

En fonction du projet et de vos droits d'accès, vous pouvez voir différents modèles (structures de données à recevoir/insérer depuis/vers la base de données). Veuillez cliquer ici rights pour obtenir la liste des modèles et des actions.