Hints for Using Our Barcode System API’s
Third party service providers use codeREADr’s API for many reasons. The most popular one is to integrate codeREADr with their services to make the end-user experience simple and intuitive.
Also, codeREADr’s Web service is transparent to customers. With our API, you can create and edit Services, Users, and Databases. Moreover, you can filter and retrieve scan records. Simply, pick and choose the APIs that best suit your needs. The scans retrieve API is popular because you can auto-fetch scan records, modify, and 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 use the API to create Users, Databases, and Questions. You should use the codeREADr.com web site to create your first Services to understand the tools.
- 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 that display 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, review the best practices articles for various applications.
3- Full API documentation
4 – Unpublished API calls. Contact email@example.com for all unpublished calls.
a) The API call for a retrieving a CSV file of scan records with an Export Template is “template=e0798bcfb95714fc&return_type=csv”.
Note: You cannot create the Export Template itself with this API call. However, you can pre-configure the template using the web service. and then add the template ID to the API call. You will have to look that up manually on the website by looking for it when creating the Export Template. Here’s what the URL looks like “https://secure.codereadr.com/account/scans/templates/e0798bcfb95714fc/”.
b) The API call for enabling Kiosk Mode is “kiosk_mode_config” with the JSON variables noted in the link.