Explore Our Barcode System API’s
Third party service providers use codeREADr’s API for many different reasons. One of the most popular is to seamlessly integrate the codeREADr with their services to make the end-user experience simple and intuitive.
An additional benefit is that codeREADr’s Web service become transparent to their customers. With our API you can create and edit Services, Users, and Databases as well as filter and retrieve scan records. You can pick and choose which APIs best suit your needs. Some clients use most of our APIs while others use only a few, most commonly our scans retrieve API. The scans retrieve API is the most popular because it offers an automated way to fetch scan records, modify them, insert them into a third party database and automate reporting.
Overview – Getting Started
1 – The core task is creating Services. [Check the Services API]
However, before you can use the API to create Services, you need to first use the API to create Users, Databases, and Questions. It is highly recommended that you use the codeREADr.com web site to create your first Services to understand how everything is linked together.
- Users: Your authorized app-users that can scan using a Service. [Check the Users API.]
- Databases: Your database of barcode values against which a scan is validated and can present specific content to the app-user after each scan). [Check the Databases API.]
- Questions: Prompts presented to the app-user to collect associated information after a scan. [Check the Questions API.]
Once you’ve created the associated User(s), Database and Question(s) you’re ready to create a Service.
2 – To get step-by-step instructions on how to use the website to create Services you can review the best practices articles for various applications.
3- Full API documentation.
4 – Unpublished API calls – contact firstname.lastname@example.org for all unpublished calls.
a) The API call for a retrieving a CSV file of scan records with an Export Template: “template=e0798bcfb95714fc&return_type=csv”
Note: You cannot create the Export Template itself with this API call but you can pre-configure the template using the web service and then add the template ID to the API call. At this time you have to look that up manually from the website by looking for it in the template URL (i.e. https://secure.codereadr.com/account/scans/templates/e0798bcfb95714fc/)
6 – IP Whitelist.