API de code QR. Qu'est-ce qu'At et comment l'utiliser ? Instructions détaillées

Pour créer un code QR pour un lien, une vidéo ou une image, cliquez sur le bouton ci-dessous.

Plus tôt, nous avons déjà envisagé la voie de la création automatique de codes QR sans interaction manuelle avec notre générateur (codes QR et Zapier - automatisation en action). Aujourd'hui, nous allons parler de l'utilisation de notre API officielle de code QR.

L'API (Application Programming Interface) est un type d'interface logicielle qui relie différents produits et services entre eux. Dans ce cas, l'implémentation interne du service embarqué dans l'architecture existante via l'API n'est pas importante pour le développeur. Cela permet d'économiser du temps de développement et de l'argent. Dans le cas des codes QR, cela se traduit par l'absence de nécessité de les créer manuellement via l'interface utilisateur du générateur avec la sauvegarde et l'insertion suivantes dans le service nécessaire.

Plus tôt, nous avons déjà envisagé la voie de la création automatique de codes QR sans interaction manuelle avec notre générateur (codes QR et Zapier - automatisation en action). Aujourd'hui, nous allons parler de l'utilisation de notre API officielle de code QR.

L'API (Application Programming Interface) est un type d'interface logicielle qui relie différents produits et services entre eux. Dans ce cas, l'implémentation interne du service embarqué dans l'architecture existante via l'API n'est pas importante pour le développeur. Cela permet d'économiser du temps de développement et de l'argent. Dans le cas des codes QR, cela se traduit par l'absence de nécessité de les créer manuellement via l'interface utilisateur du générateur avec la sauvegarde et l'insertion suivantes dans le service nécessaire.

Comment utiliser l'API du générateur de code QR ?

Pour utiliser l'API ME-QR pour la création de code QR, suivez ces 4 étapes :

Comment utiliser l'API du générateur de code QR ?

Pour utiliser l'API ME-QR pour la création de code QR, suivez ces 4 étapes :

1. Obtenez un jeton d'accès

Un jeton est un identifiant qui informe l'API que l'utilisateur du jeton est autorisé à accéder à la fonctionnalité du service répondant. Pour obtenir un jeton, rendez-vous sur le site du générateur ME-QR sous votre identifiant dans la section Informations personnelles.

1. Obtenez un jeton d'accès

Un jeton est un identifiant qui informe l'API que l'utilisateur du jeton est autorisé à accéder à la fonctionnalité du service répondant. Pour obtenir un jeton, rendez-vous sur le site du générateur ME-QR sous votre identifiant dans la section Informations personnelles.

2. Lire la documentation

Une API peut être considérée comme un contrat avec documentation entre deux parties. Cela implique une certaine réponse programmatique d'une partie à une demande distante, structurée selon la documentation, de l'autre. La documentation de l'API ME-QR est disponible à l' adresse suivante .

2. Lire la documentation

Une API peut être considérée comme un contrat avec documentation entre deux parties. Cela implique une certaine réponse programmatique d'une partie à une demande distante, structurée selon la documentation, de l'autre. La documentation de l'API ME-QR est disponible à l' adresse suivante .

3. Formuler une demande

La requête contient un certain nombre d'attributs obligatoires :

" jeton " - le jeton d'accès obtenu selon l'étape 1 de ce manuel. Il a un type de données de chaîne et est pris entre parenthèses.
" qrType " - type de code QR. Il s'agit d'une valeur de type de données entier désignant un type spécifique selon la liste des types suggérés. Vous pouvez voir la liste dans l'onglet Schéma de la page de documentation.
" titre " - le nom du code pour sa recherche pratique parmi ceux créés par vous, dans la section QR Сodes de votre compte. Il a un type de données de chaîne et est pris entre parenthèses.
" service " - un service de demande. Dans ce cas, vous devez sélectionner "api". Il a un type de données de chaîne et est pris entre parenthèses.
" format " - le format du code QR créé. Les formats suivants sont disponibles pour la sélection : "png", "jpeg", "svg", "json". Il a un type de données de chaîne et est pris entre parenthèses.
" qrOptions " - un attribut qui définit l'apparence du code QR créé. Il contient un certain nombre de propriétés (taille, couleur, forme des éléments, logo, etc.). La liste complète des propriétés et leurs valeurs se trouvent dans l'onglet Schéma de la page de documentation.
" qrFieldsData " - un attribut qui définit le contenu du code QR en cours de création. Il contient un certain nombre de propriétés, uniques pour chaque type de code sélectionné. La liste complète des propriétés et leurs valeurs pour chaque type se trouvent dans la liste des schémas sur la page de documentation.

3. Formuler une demande

La requête contient un certain nombre d'attributs obligatoires :

" jeton " - le jeton d'accès obtenu selon l'étape 1 de ce manuel. Il a un type de données de chaîne et est pris entre parenthèses.
" qrType " - type de code QR. Il s'agit d'une valeur de type de données entier désignant un type spécifique selon la liste des types suggérés. Vous pouvez voir la liste dans l'onglet Schéma de la page de documentation.
" titre " - le nom du code pour sa recherche pratique parmi ceux créés par vous, dans la section QR Сodes de votre compte. Il a un type de données de chaîne et est pris entre parenthèses.
" service " - un service de demande. Dans ce cas, vous devez sélectionner "api". Il a un type de données de chaîne et est pris entre parenthèses.
" format " - le format du code QR créé. Les formats suivants sont disponibles pour la sélection : "png", "jpeg", "svg", "json". Il a un type de données de chaîne et est pris entre parenthèses.
" qrOptions " - un attribut qui définit l'apparence du code QR créé. Il contient un certain nombre de propriétés (taille, couleur, forme des éléments, logo, etc.). La liste complète des propriétés et leurs valeurs se trouvent dans l'onglet Schéma de la page de documentation.
" qrFieldsData " - un attribut qui définit le contenu du code QR en cours de création. Il contient un certain nombre de propriétés, uniques pour chaque type de code sélectionné. La liste complète des propriétés et leurs valeurs pour chaque type se trouvent dans la liste des schémas sur la page de documentation.

4. Appliquer votre demande

Vous pouvez utiliser la demande construite à la fois directement dans votre système ou flux de travail et dans des services spéciaux pour travailler avec l'API, tels que Postman. Cette dernière approche vous permettra de mettre en place une connexion avec votre site, d'automatiser la construction des requêtes et leur envoi automatique au Facteur, pour certaines actions sur le site.

4. Appliquer votre demande

Vous pouvez utiliser la demande construite à la fois directement dans votre système ou flux de travail et dans des services spéciaux pour travailler avec l'API, tels que Postman. Cette dernière approche vous permettra de mettre en place une connexion avec votre site, d'automatiser la construction des requêtes et leur envoi automatique au Facteur, pour certaines actions sur le site.

Un autre avantage de travailler avec notre API

En travaillant avec notre API, vous obtenez des codes QR dynamiques à part entière, qui sont tous affichés dans votre compte. Cela signifie que vous pouvez ensuite modifier leur contenu sans modifier leur apparence. De plus, l'analyse de chaque code QR est fournie. Ces fonctionnalités sont disponibles dans la section QR Codes de votre compte.

Veuillez noter que l'utilisation de l'API ME-QR est disponible uniquement pour les forfaits Premium . Vous pouvez vous familiariser avec eux (comme avec les autres plans et une liste complète des avantages de chacun) en suivant ce lien . Choisissez celui qui correspond le mieux à vos besoins et commencez dès aujourd'hui à créer des codes avec l'API de notre générateur de code QR gratuit !