<aside> 💡 Welcome to the integration guide for third-party apps with Polytag! Polytag is designed to work seamlessly with any third-party app, allowing your users to scan our unique-every-time QR codes to perform a number of functions such as redeeming a drinks container deposit (Digital Deposit Return Scheme), validating product authenticity, product traceability, checking for allergens, claiming rewards, and much more!
</aside>
<aside> 💡 Each one of our QR codes is unique as they contain a random serialised code, and coupled with our secure API that leverages best in class web security, our process is anti-fraud. This short document will provide you with instructions on how to integrate your app with our application. Before we get started, please note that this guide assumes that you have some basic knowledge of how Polytag works and have access to the necessary credentials and APIs for the third-party app you wish to integrate.
</aside>
API format: each endpoint is published as a REST-style API call with a JSON payload, accessible over the internet via HTTPS.
Data formats: all data payloads will be in JSON format.
Interface availability: interfaces will ordinarily be available 24/7, except for pre-scheduled downtime.
Polytag has 2 different API endpoints you can use:
apis.polyt.ag: The staging environment, the endpoint you should use when testing and developing new features.
api.polyt.ag: The production environment, the one you will use after your feature development is done and you’re ready for your customers to use it!
These endpoints are in different environments, so you will have different credentials for each of them. Our examples will use the staging environment endpoint.
As the first step you will need to request an account from Polytag. Polytag will send you an invite to create a third party user account in our portal. The endpoints you have access to are determined by Polytag admins and you can verify your permissions on the portal.
Access to the API is contingent on the third party following any guidelines or restrictions specified by Polytag to ensure that the resources are being used appropriately and responsibly. Failure to adhere to this will lead to a revocation of access.
If you need any assistance with this, please contact the Polytag team at [email protected].