apyhub-logo
60 atoms
Base tier

About

This Utility API lets you dynamically generate Barcodes.
Barcodes are a system of encoding data in a visual format that can be read by a machine. Barcodes can improve accuracy by reducing errors caused by manual data entry. This is because barcodes can be scanned automatically, which eliminates the need for manual data entry and the errors that can come with it.
Endpoint Selector
Output

API Playground

Documentation

generate barcode file
POST
https://api.apyhub.com/generate/barcode/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/barcode/file?output=sample.png' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
"content":"https://apyhub.com"
6
}'
Method: POST
Content Type: application/json
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name for the Barcode code file. If no output attribute is provided, the default file name will be output.png
Request Body
AttributeTypeMandatoryDescription
contentStringYesAny content that you want to Barcode to point to, content length should be less then 80 characters
Sample Response
A successful request returns the Barcode image file.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the content is empty
500If any unexpected error occurs while processing the request

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.