L’API GetQR est en version bêta et réservée à certains espaces de travail. Certains détails peuvent changer avant la disponibilité générale.
styles, frameOptions et logoOptions. Il ne contient jamais de contenu ni de lien. Les modèles sont partagés par tous les membres de l’espace de travail.
Appliquer un modèle
TransmetteztemplateId quand vous créez un QR code. Le design du modèle est appliqué au nouveau QR code. Chacun des trois objets de design que vous envoyez dans la même requête est fusionné par-dessus.
- Copié, pas lié. Le QR code conserve sa propre copie du design. Modifier ou supprimer le modèle par la suite ne le change pas.
- Designs personnalisés uniquement. Un modèle dont le
designKindvautbrandedouaine peut pas être appliqué via l’API et renvoie422(art_template_unsupported). - Votre espace de travail uniquement. Un modèle inconnu, ou provenant d’un autre espace de travail, renvoie
404.
En-têtes
string
requis
Bearer suivi de votre clé API. Consultez Authentification.string
application/json. Obligatoire pour les requêtes avec un corps.L’objet modèle
string
ID du modèle, par exemple
qrt_8Hs2mQvKpLd4RtYw.string
Nom affiché au moment de choisir un modèle.
string
Lecture seule.
custom est un design que l’API peut modifier entièrement. branded et ai sont un Branded design ou un AI design créé dans le tableau de bord : son image ne peut pas être modifiée via l’API, et elle est conservée quand vous modifiez les autres champs de design.object
Le design enregistré. Chaque champ a la même structure que le champ de requête du même nom : vous pouvez donc le renvoyer tel quel.
string
Date de création, ISO 8601.
string
Date de dernière mise à jour, ISO 8601.
Lister les modèles
GET /api/v1/templates
Renvoie les modèles de votre espace de travail, du plus récent au plus ancien. La liste est paginée : consultez Pagination.
integer
défaut:"1"
Page à renvoyer, 1 ou plus.
integer
défaut:"100"
Résultats par page, de 1 à 100.
Créer un modèle
POST /api/v1/templates
Enregistre un nouveau design. Répond 201 Created. Les champs de design sont vérifiés par rapport aux catalogues de Personnalisation : une forme, un cadre ou un logo inconnu est donc refusé avec 422.
string
requis
Nom affiché au moment de choisir un modèle, de 1 à 40 caractères.
object
Formes et couleurs des points et des coins. Consultez Personnalisation.
object
Cadre dessiné autour du QR code et son texte d’appel à l’action. Consultez Personnalisation.
object
Logo placé au centre : un logo suggéré, ou votre propre fichier importé avec la cible
logo de Fichiers. Consultez Personnalisation.Récupérer un modèle
GET /api/v1/templates/{templateId}
string
requis
ID du modèle. Récupérez-le dans la réponse de liste ou de création.
Modifier un modèle
PATCH /api/v1/templates/{templateId}
N’envoyez que les champs à modifier. Les objets de design sont fusionnés avec le design enregistré : un styles partiel conserve donc le reste. Les QR codes déjà créés à partir du modèle gardent le design avec lequel ils ont été créés.
string
requis
ID du modèle.
string
Nouveau nom, de 1 à 40 caractères.
object
Modifications de style, fusionnées avec les
styles enregistrés.object
Modifications du cadre, fusionnées avec le cadre enregistré.
object
Modifications du logo, fusionnées avec le logo enregistré.
Supprimer un modèle
DELETE /api/v1/templates/{templateId}
Supprime le modèle. Les QR codes créés à partir de celui-ci conservent leur design.
string
requis
ID du modèle.
Dupliquer un modèle
POST /api/v1/templates/{templateId}/duplicate
Crée une copie nommée <name> copy, avec son propre ID et un design indépendant que vous pouvez modifier librement. Pas de corps de requête. Répond 201 Created.
string
requis
ID du modèle à copier.
Problèmes courants
404 "QR template not found."
404 "QR template not found."
Le
templateId ne correspond à aucun modèle de votre espace de travail. Récupérez-le avec Lister les modèles.422 lors de la création ou de la modification d'un modèle
422 lors de la création ou de la modification d'un modèle
Un champ de design ne correspond pas aux catalogues, par exemple un type de point, un cadre ou un logo suggéré inconnu. Le message indique le champ. Consultez Personnalisation.
422 art_template_unsupported lors de la création d'un QR code
422 art_template_unsupported lors de la création d'un QR code
Le modèle utilise un Branded design ou un AI design. Appliquez plutôt un modèle dont le
designKind vaut custom.