Use this guide to know where you can use your API Key in the QR API tool.
Once you've generated an API key using the QR API tool, it's crucial to know how to utilize it correctly. The key provides access to various API functions, including testing the API through the API Playground & Documentation page.
To find your API Key, please refer to: How do I find my API Key
The below steps can be followed to use the API Key correctly:
- Access the API Playground: Go to the QR API's 'Documentation' section on the Dashboard. This is where you'll be able to test the functionality of your API key and generate QR codes
- Authorize Your API Key: To be able to test the API in the API Playground & Documentation page, it is necessary to authorize using your API Key. Click on the 'Authorize' button and follow the below step
- Paste Your API Key: In the pop-up box, paste your API key and click 'Authorize'. Your API key is now connected and ready for use
- Select QR Code Type: Choose which QR code you wish to generate. Click the 'Get' button associated with your desired QR code type. For example, if you want to generate a Website URL QR Code, select the /qrcode/url option
- Enable Parameter Fields: After selecting the QR code type, click on the 'Test' button. This will enable the parameter fields where you can input necessary values
- Set Parameter Values: Enter the values for the parameters according to your needs. These could be details like the URL for a website QR code or text for a text QR code
- Execute the Test: Once you've specified the data for the parameters, click on 'Execute'. This will generate a QR Code and a request URL based on the parameters you have set
- Test the QR Code: To test the generated QR code, copy the request URL and paste it into a new browser tab. If the QR code works correctly, it will redirect to the specified parameter data, such as a website or a text message
By following these steps, you can easily use your API key and test QR API's Playground & Documentation section. This enables you to generate various types of QR Codes and ensure everything is functioning as expected.
If you still have questions related to this topic, feel free to reach out to our customer relations team at firstname.lastname@example.org.