Skip to content

codeREADr API · Version 1.0

Build barcode scanning into your stack

Configure services, users and devices, validate barcodes against your own databases, and stream scan records to your server the moment they happen.

Get started Browse the API reference

Start here

  • Authentication & requests

    Find your API key and learn the four ways to submit variables — form-encoded POST (recommended), XML file, XML string, or GET.

    API overview

  • Services

    Create and configure the scanning services your devices run, authorize users, and attach questions.

    Services API

  • Databases

    Upload barcode values by CSV or API, set custom responses and results, then search and edit them.

    Databases API

  • Scans

    Retrieve and search scan records, including answers to questions and captured location data.

    Scans API

  • Direct Scan to URL

    Have the scanner post each scan straight to your server and return your own validation response in real time.

    Postback & DSU

  • Barcode Generator

    Generate plain or branded barcodes across every supported symbology.

    Barcode Generator API

How the API works

Every request goes to a single endpoint and is routed by two variables — section (the part of your account) and action (what to do with it) — authenticated with your api_key.

POST https://api.codereadr.com/api/

curl -X POST \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "api_key=YOUR_API_KEY&section=services&action=retrieve" \
     https://api.codereadr.com/api/

The API responds with raw XML carrying either a success status and the data you asked for, or a failure status and an error description:

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <status>1</status>
    <service id="1234">
        <name>Front Gate</name>
    </service>
</xml>

Keep your API key out of URLs

GET requests put your key in the query string, in server logs and in browser history — so they are disabled by default. Use POST in production. See Submitting Variables.

Reference tables

  • Error codes

    Every failure code the API can return, and what it means.

    Error codes

  • Limits

    Retrieve the API limits that apply to your account.

    Limits

  • Symbologies

    Barcode type IDs accepted by the scanning and generator endpoints.

    Symbologies

  • Timezones

    Timezone IDs for service and scan timestamp configuration.

    Timezones

Before you start

Need a hand? Contact support or browse the knowledge base.