Information
du Paquet

API générale

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

Structure générale du message

La communication se fait en envoyant des données JSON dans les deux sens. Pour démarrer une action, veuillez envoyer une requête POST avec les données JSON suivantes dans le corps HTTP:

{
  "accessType": 1,         // Access type
  "action":     "...",     // Action to perform  
  "model":      "...",     // Model to perform the action to  
  "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 peut être nécessaire pour certaines actions (par exemple la création d'un nouvel utilisateur). Veuillez contacter votre responsable de compte afin de recevoir votre clé.

Important: Gardez votre clé privée et ne la transmettez pas via le navigateur mais toujours via une connexion serveur à serveur!

L'API répondra avec un corps JSON qui est 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  
}

les codes d'erreur

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

Code Détails
100-199 Codes d'erreur généraux
101 Aucune donnée d'entrée trouvée
102 view / accessType manquant ou incorrect
103 Aucun ID soumis / ID invalide. Veuillez envoyer au moins une pièce d'identité
104 Filtre incorrect: le champ X n'existe pas dans Y
105 l'action est manquante ou incorrecte
106 Le paramètre X est obligatoire / manquant
107 Action de la barre d'outils inconnue ou vide
108 Action non autorisée
109 Action: échoué
110 L'action n'autorise pas plus d'un / ou aucun ID.
111 Données pour l'ID x introuvables.
112 Créer une erreur, voir le message d'erreur. Messages spécifiques au champ voir response.data
113 Erreur de mise à jour, voir le message d'erreur. Messages spécifiques au champ voir response.data
114 Aucune donnée pour créer / mettre à jour un élément
115 Les ID doivent être un tableau
116 Impossible de signer le mot de passe
117 Quantité maximale d'articles dépassée
   
200-299 Erreurs de connexion / d'accès
201 Adserver désactivé
202 Utilisateur non trouvé
203 IP sur liste noire
204 Mot de passe incorrect
205 Informations d'identification manquantes
206 Erreur de connexion inconnue
207 IP non sur la liste blanche
208 Changement de mot de passe nécessaire (mot de passe trop ancien)
209 Accès non autorisé
210 Le renouvellement du mot de passe échoue

211

Jeton incorrect
212 Le jeton a expiré
213 Compte pas encore actif
214 Type d'accès inconnu
215 Changement de mot de passe nécessaire
216 Désactivé
217 Erreur inconnue
218 Clé d'authentification manquante ou vide
219 Authentification à deux facteurs manquante (paramètre d'envoi 2fa)
220 Authentification à deux facteurs incorrecte
221 Deux facteurs : code OTP manquant
222 Deux facteurs : code OTP incorrect
223 Double facteur : code de messagerie manquant
224 Double facteur : code de messagerie incorrect
225 Deux facteurs : code SMS manquant
226 Deux facteurs : code SMS incorrect
227 Double facteur : le courrier est envoyé maintenant
228 Deux facteurs : le SMS est envoyé maintenant
229 E-mail de mise à jour du mot de passe envoyé
230 Mot de passe mis à jour
   
300-399 Codes d'erreur internes
301 Impossible de résoudre la dépendance de X sur Y
302 La dépendance pour X a abouti à une liste vide
303 Aucune colonne à mettre à jour
304 Erreur de dépendance sur l'utilisation du champ
305 Erreur de dépendance sur un champ vide
306 La requête de liste a abouti à une liste de champs vide
307 Rappel d'authentification introuvable
308 Fichier d'inclusion API introuvable: ...
399 Erreur interne générale
   
900-999 Codes d'erreur personnalisés, veuillez consulter le message

Types d'accès

Selon la structure de l'API, différents types d'accès existent (champ JSON "accessType"). Veuillez contacter votre gestionnaire de compte afin de recevoir l'ID du type d'accès que vous pouvez utiliser.

Des modèles photo

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 / dans la base de données). Veuillez appeler l'action rights afin de recevoir une liste de modèles et d'actions.

Retour en haut de la page