1. Krijg een toegangstoken

Een token is een referentie die de API informeert dat de tokengebruiker geautoriseerd is om toegang te krijgen tot de functionaliteit van de antwoordende service. Om een ​​token te krijgen, gaat u naar de ME-QR-generatorsite onder uw login in het gedeelte Persoonlijke informatie.

2. Lees de documentatie

Een API kan worden beschouwd als een contract met documentatie tussen twee partijen. Het impliceert een bepaalde programmatische reactie van de ene partij op een verzoek op afstand, gestructureerd volgens de documentatie, van de andere. De ME-QR API-documentatie is te vinden op het volgende adres .

3. Formuleer een verzoek

Het verzoek bevat een aantal verplichte attributen:

• " token " - het toegangstoken verkregen volgens stap 1 van deze handleiding. Het heeft een gegevenstype string en staat tussen haakjes.
• " qrType " - type QR-code. Het is een geheel getal van het gegevenstype dat een specifiek type aangeeft volgens de lijst met voorgestelde typen. U kunt de lijst bekijken op het tabblad Schema van de documentatiepagina.
• " titel " - de naam van de code om gemakkelijk te kunnen zoeken tussen de codes die door u zijn gemaakt, in het gedeelte QR-codes van uw account. Het heeft een gegevenstype string en staat tussen haakjes.
• " service " - een aanvraagservice. In dit geval moet u "api" selecteren. Het heeft een gegevenstype string en staat tussen haakjes.
• " formaat " - het formaat van de aangemaakte QR-code. De volgende formaten zijn beschikbaar voor selectie: "png", "jpeg", "svg", "json". Het heeft een gegevenstype string en staat tussen haakjes.
• " qrOptions " - een attribuut dat het uiterlijk van de gemaakte QR-code bepaalt. Het bevat een aantal eigenschappen (grootte, kleur, vorm van elementen, logo, enz.). De volledige lijst met eigenschappen en hun waarden is te vinden op het tabblad Schema van de documentatiepagina.
• " qrFieldsData " - een attribuut dat de inhoud definieert van de QR-code die wordt gemaakt. Het bevat een aantal eigenschappen, uniek voor elk geselecteerd codetype. De volledige lijst met eigenschappen en hun waarden voor elk type is te vinden in de lijst Schema's op de documentatiepagina.

4. Pas uw verzoek toe

U kunt het gebouwde verzoek zowel rechtstreeks in uw systeem of workflow gebruiken als in speciale services voor het werken met API, zoals Postman. Met deze laatste benadering kunt u een verbinding met uw site tot stand brengen, de opbouw van verzoeken en hun automatische verzending naar Postman automatiseren voor bepaalde acties op de site.

Door met onze API te werken, krijgt u volwaardige dynamische QR-codes, die allemaal in uw account worden weergegeven. Dit betekent dat u vervolgens hun inhoud kunt wijzigen zonder hun uiterlijk te veranderen. Bovendien wordt de analyse van elke afzonderlijke QR-code verstrekt. Deze functies zijn beschikbaar in het gedeelte QR-codes van uw account.