Introduction

WalletApp LPR intergration api

This documentation aims to provide all the information you need to work with our API.

Base URL

http://localhost

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Endpoints

LPR scan api.

requires authentication

This api allows you to scan a licenseplate and retrieve its known data

Example request:

curl --request GET \
    --get "http://localhost/K589BZ?stream=Lane_1&has_credit=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/K589BZ"
);

const params = {
    "stream": "Lane_1",
    "has_credit": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "is_member": true,
    "has_credit": false,
    "member_data": {
        "user_exists": true,
        "subscription_id": null,
        "subscription_program": null,
        "subscription_upgrade_program": null,
        "licenseplate": "K589BZ",
        "user_identifier": "",
        "balance": 0,
        "brand": "FORD",
        "color": "WIT",
        "type": "PersonenAuto",
        "admission": "2020"
    },
    "is_taxi": 0
}

Example response (401):


{
    "message": "Unauthenticated"
}

Received response:

Request failed with error:

Request

GET {licenseplate}

URL Parameters

licenseplate string

The scanned Licenseplate.

Query Parameters

stream string optional

The external stream reference defined in the backoffice.

has_credit boolean optional

Example value if credit needs to be set.