Passer au contenu
Tous les guides

Gérer les produits avec l’API

Reliez votre catalogue de produits ou votre système d’emballage à CodePersist. Votre équipe peut tenir les fiches produits à jour, choisir quand publier les changements et préparer les codes QR pour l’impression.

Consulter la référence de l’API

Relier votre système

L’API est incluse dans les forfaits Lite et Premium. Un propriétaire de l’organisation peut créer dans CodePersist une clé pour le système à relier.

Créer une clé API

Donnez à la clé un nom qui permet de reconnaître le système qui l’utilise. Copiez le secret à la création de la clé et conservez-le dans un espace sécurisé. CodePersist ne l’affiche qu’une fois.

Ouvrir les clés API

Choisir les droits de la clé

Une clé en lecture seule permet de consulter les produits et leur historique, de prévisualiser les codes QR et de télécharger les fichiers existants. Choisissez l’accès en lecture et écriture si votre système doit aussi faire des changements ou générer des fichiers pour l’impression.

Prévoir l’expiration de la clé

Remplacez la clé avant son expiration pour maintenir la connexion de votre système. Les codes QR déjà publiés continuent de fonctionner comme avant.

Remplacer ou révoquer une clé

Créez une clé de remplacement et vérifiez que votre système fonctionne avec celle-ci avant de révoquer l’ancienne. Si vous pensez qu’une clé a été compromise, révoquez-la immédiatement.

Suivre le cycle de vie d’un produit

1. Créer un produit

Commencez par un produit de votre catalogue. Utilisez le nom que votre équipe reconnaît, le numéro de code-barres (GTIN) sur l’emballage et la page Web à ouvrir au balayage. CodePersist enregistre le produit pour que vous puissiez le vérifier avant sa mise en ligne.

Consultez la référence de l’API pour savoir comment créer un produit et quelles informations transmettre.

2. Publier le produit

Vérifiez les liens du produit avant de publier la version enregistrée. La publication rend cette version accessible aux personnes qui balaient le code QR. Consultez l’historique de publication pour confirmer quelle version est en ligne.

La référence de l’API explique comment publier un produit et consulter l’historique de publication.

3. Préparer le code QR pour l’impression

Une fois la dernière version du produit publiée, téléchargez le SVG pour l’impression avec une clé en lecture seule ou en lecture et écriture. Vous pouvez inclure un lot, un numéro de série, une date d’expiration ou un poids net pour chaque code. Balayez le code sur une épreuve pour vérifier qu’il ouvre la bonne page avant d’imprimer l’emballage.

Consultez la référence de l’API pour savoir comment télécharger un fichier d’impression pour le code QR.

4. Faire des changements après la mise en ligne

Si la page du produit change d’adresse ou si ses liens changent, partez de la dernière version enregistrée. Enregistrez vos changements, puis vérifiez la nouvelle version. Publiez-la quand vous souhaitez que les changements soient visibles au balayage.

La référence de l’API indique comment consulter la fiche produit actuelle et enregistrer les changements apportés à un produit.

5. Mettre le produit hors ligne

Si le produit ne doit plus être accessible par son code QR, désactivez-le. CodePersist conserve le produit et son historique. Attendez que le produit soit indiqué comme désactivé avant de poursuivre.

Consultez la référence de l’API pour savoir comment désactiver un produit ou relancer une désactivation qui a échoué.

6. Réactiver ou supprimer le produit

Si le produit revient, réactivez-le et republiez-le pour rétablir l’accès par le code QR. Si vous n’avez plus besoin de sa fiche, vous pouvez la supprimer définitivement une fois le produit entièrement désactivé.

La référence de l’API explique comment réactiver un produit désactivé ou supprimer définitivement un produit désactivé.

Gérer vos produits

Retrouver des produits et consulter leurs anciennes versions

Si vous devez annuler une modification, restaurez une ancienne version. CodePersist enregistre ce contenu dans une nouvelle version que vous pouvez vérifier avant de la publier.

Consultez la référence de l’API pour savoir comment retrouver des produits dans le catalogue, consulter les versions enregistrées ou restaurer une ancienne version.

Utiliser votre propre domaine

Connectez et vérifiez d’abord le domaine dans CodePersist. Vous pouvez ensuite l’associer de façon permanente à un produit admissible créé avec une adresse CodePersist.

Publiez le produit mis à jour et générez un nouveau fichier pour imprimer des codes qui utilisent votre domaine. Les codes déjà imprimés conservent l’adresse CodePersist.

La référence de l’API indique comment associer un domaine personnalisé après l’avoir configuré dans CodePersist.

Utilisez votre domaine dans vos codes QR

Gérer plusieurs produits à la fois

Appliquez la même action à un maximum de cinq produits à la fois. Vérifiez le résultat pour chaque produit, car certains peuvent nécessiter une intervention.

La référence de l’API explique comment publier plusieurs produits, désactiver plusieurs produits, réactiver plusieurs produits ou supprimer plusieurs produits désactivés en une seule requête.

En cas de problème

Si vous ne savez pas si un changement a été appliqué, vérifiez le produit dans CodePersist avant de réessayer. Si quelqu’un d’autre l’a modifié, vérifiez d’abord la version la plus récente.

Référence de l’API

Partagez la référence avec l’équipe qui crée votre intégration. Elle explique comment établir la connexion, quelles informations envoyer et quoi attendre en retour pour chaque action.

Consulter la référence de l’API