RACO Barcode API v1.2 Features
- Support for 5 1D Barcode Symbologies including Code 128,
Code 39, Interleaved 2 of 5, UPC-A and UPC-E
- Support for 5 2D Barcode Symbologies including Aztec Code,
DataMatrix, PDF417, QR Code and Semacode
- Several image formats supported including JPG, GIF, PNG and
EPS
- User defined image resolution (DPI)
- User defined width, height and margin sizes
- Blazing fast barcode generation performance
- Usage reports
- Dedicated support team
- SSL encryption option
- Service hosted in state-of-art datacenters with infinite
scalability
Have additional questions or feature
set requests? Contact Us Today!
RACO Barcode API Getting Started Guide
Service Information
The Barcode API is a simple web service that accepts HTTP GET
requests and returns barcode images that conform the parameters in
the requests. The image type returned is determined by the image
format parameter that you specify.
Your Client ID
When you registered, you were assigned a client ID. The service
uses your client ID to identify you and to track your requests. Do
not share your client ID with anyone else!
Getting Started With a Simple Request
For our first request, let's generate a Code 39 barcode. You will
be calling
http://service.barcodeapi.com/CreateBarcode.aspx?
to create your barcodes. Now we need to set our parameters.
- Provide your client ID: CID=<your-client-id>
- Specify the symbology: &S=Code39
- Specify the barcode unit: &BCU=Inch
- Specify the bar width: &BW=0.020
- Specify the bar height: &BH=0.5
- Specify the quiet zone width: &QZ=0.1
- Specify the top margin: &TM=0.1
- Specify the bottom margin: &BM=0.1
- Specify that you want to display the data under the barcode:
&DC=T
- Specify that you want to display the start and stop symbols:
&DSSC=T
- Specify the data to encode: &C=RACO%20INDUSTRIES (notice
that the value to encode is URL encoded, you must URL encode all
values passed to the service)
- Specify the image format you wish to receive (in this case,
a GIF): &IFMT=GIF
- Specify the image resolution (DPI): &DPI=72
Once you add all of the parameters to the base URL, your request
will look like this:
|
http://service.barcodeapi.com/CreateBarcode.aspx?CID=<your-
client-id>&S=Code39&BCU=Inch&BW=0.020&BH=0.5&QZ=0.1&TM=0.1&
BM=0.1&DC=T&DSSC=T&C=RACO%20INDUSTRIES&IFMT=GIF&DPI=72
|
The image returned will look like this:
Each symbology supports different parameters. Each symbology page
has a list of supported parameters for that particular symbology.
Please register for a trial account to receive access to detailed
symbology parameters.
Image Formats
Supported Image Format Codes (IFMT):
JPG
PNG
GIF
EPS
Handling Errors
When you receive an HTTP response from the service, you can check
an HTTP header called BarcodeApiResponseCode to determine whether or
not your request was processed successfully. Code 200 indicates a
valid response, and the image data will be included in the response.
There are cases when you may receive an error code from the service.
These error codes are listed below along with their meanings.
| Response Code |
Meaning |
Description |
| 200 |
OK |
Indicates a successful request |
| 401 |
Invalid
Parameter(s) |
One or more request parameters
were invalid |
| 402 |
Unauthorized |
No client ID was specified, or an
invalid client ID was specified |
| 403 |
Request Limit
Exceeded |
The client ID specified has exceeded the maximum number
of requests per day |
| 404 |
Trial Expired |
The client ID specified has
exceeded the trial period |
Keeping Track of Your Requests
During your trial period, you will be limited to a low number of
requests per day for testing purposes. Once your account is approved
by an administrator, you will be allowed a certain number of
requests per day (depending on your contract). You can check your
customer summary page to see how many requests you have performed
each day. Only those requests that generated a valid barcode will be
counted against your total.
Back to RACO Barcode API main
page
