Knowledge Base

View Categories

Explore our APIs

Hints for Using Our Barcode System APIs

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, insert them into a third-party database, and automate reporting.

Overview – Getting Started

  • Services: The core task is creating Services (workflows). We recommend configuring your first service using the CodeREADr.com website to familiarize yourself with all the options. [Services API]
  • Users: Your authorized app-users who can scan using a Service. [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. [Databases API]
  • Questions: Prompts are displayed to the app user to collect associated information after a scan. [Questions API]

Unpublished API Calls

Contact support@codereadr.com for all unpublished calls.

  • The API call for 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.

Full API documentation is available in addition to our instructions in the Knowledge Base on how to use the website to create Services.

There are three ways of posting API requests. As well, you may need to whitelist your IP address.

Pricing and Limits

Testing of our APIs is available to free accounts. For production usage, the is available for accounts with a Paid Plan subject to the following API Limits:

    • Business Starter: 30 API calls per minute
    • 5-Device Plan: 60 API calls per minute
    • 10-Device Plan: 90 API calls per minute
    • 25-Device Plan: 180 API calls per minute

    An API call is counted when the CodeREADr server receives a call from a third party’s server. We strongly encourage developers to be efficient in the use of our API.

    API calls specifically do not count requests from the CodeREADr mobile app (Scans, Lookup, History, etc.) to either the CodeREADr server or from the CodeREADr mobile app to a third-party server.

    You will get an email alert if you exceed your paid plan limit of API calls. We only send one alert a day by email. However, for each failed call, we return an error message to your server. The count is reset each minute so you can resend blocked calls after that minute is up.

    Did this article help?