API client

En cas de différence avec la version anglaise, la version anglaise prévaut.

L’API client est un service local intégré à l’application pour une automatisation avancée. Il ne s’agit pas de l’API du cloud public et ne doit pas être exposée à des réseaux non fiables.

Utilisations typiques

Utilisez l’API locale lorsque vous souhaitez qu’un script ou un outil local approuvé :

• déclencher la synchronisation du deck ;
• lister les decks cloud ou locaux ;
• créer un deck ;
• récupérer un deck depuis le cloud ;
• mettre à jour les métadonnées du deck ;
• supprimer un deck local ;
• lister les catégories ;
• créer, mettre à jour, rechercher ou supprimer des cartes ;
• télécharger ou supprimer des ressources de deck ;
• intégrer Cardary à un flux de travail personnel.

Authentification

Les points de terminaison protégés nécessitent l’état de connexion de l’application et un secret local via :

• l’entête X-API-SECRET ; ou
• le paramètre de requête secret.

Traitez le secret comme un identifiant. Ne le collez pas dans les journaux publics, l’historique du navigateur, les scripts partagés ou les services distants.

Groupes de points de terminaison

L’application comprend des groupes de points de terminaison pour :

Groupe	Objectif
Authentification	Vérifiez la connexion et l’état d’accès à l’API locale.
Synchroniser	Déclenchez ou inspectez la synchronisation du deck.
Ponts	Répertoriez, créez, récupérez, mettez à jour et supprimez des decks.
Catégories	Lisez la structure des catégories de deck.
Cartes	Recherchez, créez, mettez à jour et supprimez le contenu de la carte.
Ressources	Téléchargez et supprimez les médias ou les fichiers utilisés par les cartes.

Les formes exactes de charge utile peuvent changer selon les versions de l’application. Vérifiez l’implémentation de l’application lors de la création d’une intégration stricte.

Règles de sécurité

• Utilisez l’API uniquement sur des machines de confiance.
• Ne le liez pas aux réseaux publics.
• Ne partagez pas le secret local.
• Testez d’abord sur un petit deck.
• Synchronisez avant et après de grandes modifications automatisées.
• Sauvegardez ou exportez les decks importants avant les mises à jour groupées.
• Évitez les modifications simultanées à partir de l’interface utilisateur et d’un script, sauf si vous comprenez le comportement de synchronisation.

Modèles d’automatisation

Bons candidats :

• créer un deck à partir d’un pipeline de données local ;
• mettre à jour les cartes à partir d’une exportation CSV examinée ;
• joindre des images ou de l’audio générés ;
• déclencher la synchronisation après une importation contrôlée ;
• fiches de recherche pour les contrôles de qualité locaux.

Candidats à risque :

• suppression de grands jeux de cartes sans sauvegarde ;
• réécriture des champs sur un deck sans aperçu ;
• télécharger les résultats de l’IA non révisés ;
• exécuter des scripts pendant qu’un autre appareil édite le même deck ;
• exposer l’API via un serveur distant.

Dépannage

Problème	Que vérifier
La demande n’est pas autorisée	État de connexion et X-API-SECRET.
Le deck ne peut pas être modifié	Propriété du deck, état en lecture seule et compatibilité des types de deck.
Le téléchargement des ressources échoue	Plus les limites des pièces jointes, le chemin du fichier, la taille et le réseau.
La synchronisation ne met pas à jour un autre appareil	Exécutez la synchronisation sur les deux appareils et attendez les ressources.
Erreur de charge utile	Comparez votre demande avec la mise en œuvre actuelle de l’application.

Connexes : Compte et synchronisation et Importer des cartes.