Table of Contents
CodeREADr APIs – Overview
CodeREADr’s APIs enable seamless integration with third-party services, enhancing the end-user experience with intuitive and streamlined functionalities. Whether you’re looking to manage users, databases, or scan records, our APIs provide the tools to tailor solutions to your specific needs.
Why Use CodeREADr’s APIs?
- Intuitive Integration: Simplify workflows by integrating CodeREADr with your systems.
- Comprehensive Functionality: Use our APIs to create and edit Services, Users, and Databases, and to filter or retrieve scan records.
- Automated Reporting: The popular Scans Retrieve API allows you to auto-fetch, modify, and insert scan records into third-party databases while automating reporting processes.
Getting Started with CodeREADr APIs
Understand Core Tasks. The primary goal is to create Services, but this requires setting up the following components first:
- Users: Authorized app users for scanning services. Explore the Users API.
- Databases: Validate scans against barcode values and display specific content. Explore the Databases API.
- Questions: Collect additional information from app users after each scan. Explore the Questions API.
- To familiarize yourself with the process, we recommend creating your first Service using the CodeREADr web platform.
API Examples
Scans Retrieve API
- Fetch scan records in bulk for reporting and database integration.
- Example API call for retrieving a CSV file:
- template=e0798bcfb95714fc&return_type=csv
- Note: Pre-configure the Export Template via the web platform and locate the template ID.
Kiosk Mode Configuration
Enable Kiosk Mode for the CodeREADr app using the kiosk_mode_config API call with JSON variables. Check developer APIs for more information.
API Request Methods and IP Whitelisting
There are three ways to post API requests:
- Direct API calls from your server to CodeREADr.
- Webhook integrations to automate workflows.
- Third-party applications for added flexibility.
Ensure your server’s IP address is whitelisted for secure access.
Pricing and API Call Limits
Free and Paid Plans
- API testing is available on free accounts. For production use, a Paid Plan is required. Check here for pricing.
- API Call Definition: Each call to the CodeREADr server from a third-party server counts toward your limit. Calls made directly by the CodeREADr mobile app (e.g., Scans, Lookup, History) do not count.
Usage Alerts
- Receive daily email alerts if you exceed API call limits.
- Blocked calls are reset every minute, allowing you to resend them promptly.