× Initiating database migration review
× Database migration started

API Documentation


Vision API work flow

1. Authentication - To get the authorisation token based on client ID and client Secret.
2. Image Lookup - send image with the auth token to get the results back.

Please reach out to your Account Manager if you are having issues with the token or have not received the client ID and client Secret.


Authentication (Use OAuth2.0 Framework)


The token will be valid for a period of time (current setting is 24 hours). You will need to get a new token by calling above API before the token expires.

Request: https://bauth.blippar.com/token


See: http://tools.ietf.org/html/rfc6749


The 3rd party ID. See: http://tools.ietf.org/html/rfc6749


The 3rd party Secret key. See: http://tools.ietf.org/html/rfc6749

Response: JSON with the following field
token_type e.g: "Bearer"
access_token Hash

See: http://tools.ietf.org/html/rfc6749


ImageLookup - API for Image processing

REQUEST: https://bapi.blippar.com/v1/imageLookup • Headers
Authorization Token (token_type + " " + access_token) (required)
LatLong The request location if available
LatLongAccuracy The accuracy to the meters
Language Language tag. e.g: en-US
DeviceOS Operating system of the device
DeviceType Type of Device
DeviceVersion Version of Device
UniqueID Needed if the server personalization is desired.
Accelerometer "0.0, -9.8, 0.0" with gravity removed.
DeviceOrientation "0/90/180/270"

portrait - 0, landscape left - 90, portrait upsidedown - 180, landscape right - 270

CameraSensorOrientation If not specified, server assume a default of 90
Gyro "0.0, 0.0, 0.0"

• Body: Multipart form data
input_image {image_path}

RESPONSE: json with the following fields • Headers
Connection Keep-Alive
Content-Type multipart/form-data; boundary=....
Date Current Date
Transfer-Encoding chunked

• Body: information about the entities found in zipped JSON array
id This will be the entityid about the recognized object.
name The entity name
displayname The words to display in UI.
thumbnailurl CDN url for fetching the icon image for the entity.
matchingarea [[x1, y1], [x2, y2], [x3, y3], [x4, y4]] array of points defining the matching area in the input image. (x, y) is normalized to [0-1]
matchtypes An array of matched types: image/OCR/barcode/...
score The matching score
passparams The 3rd party client just pass this field value to all the following calls to the system. One example usage is to pass the request Id back for join different server calls to form the event stream.