InfoServices API Documentation

Postman collection → OpenAPI spec →

Introduction

Welcome to the InfoServices API documentation. This comprehensive guide provides all the information you need to integrate with our powerful vehicle information and document management services.

Our API offers endpoints for:
- Retrieving vehicle mileage history using license plates or VIN numbers
- Managing documents with creation and synchronization capabilities
- Secure authentication and authorization for all operations

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

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

Use the key given to you to authenticate.

Authentication

APIs for user authentication

Authenticate a user and generate an API token

POST
https://infoservices.guisoft.pt
/api/auth/login

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://infoservices.guisoft.pt/api/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"john_doe\",
    \"password\": \"password123\"
}"
Example response:

Vehicles

APIs for retrieving vehicle information

Get vehicle mileage by license plate

GET
https://infoservices.guisoft.pt
/api/vehicle/plate/{plate}/mileage
requires authentication

This endpoint retrieves the mileage information for a vehicle identified by its license plate.

Headers

Authorization
Example:
Bearer {YOUR_AUTH_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

plate
string
required

The license plate of the vehicle.

Example:
07-IS-81
Example request: 
curl --request GET \
    --get "https://infoservices.guisoft.pt/api/vehicle/plate/07-IS-81/mileage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
 "data": {
     "plate": "07IS81",
     "vin": "TEST82633A123456",
     "events": [
         {
             "event_date": "2015-10-13 00:00:00",
             "vehicle_mileage": 200000
         },
         {
             "event_date": "2015-03-06 00:00:00",
             "vehicle_mileage": 171000
         },
     ]
 }
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Vehicle not found"
}

Get vehicle mileage by VIN

GET
https://infoservices.guisoft.pt
/api/vehicle/vin/{vin}/mileage
requires authentication

This endpoint retrieves the mileage information for a vehicle identified by its Vehicle Identification Number (VIN).

Headers

Authorization
Example:
Bearer {YOUR_AUTH_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

vin
string
required

The Vehicle Identification Number (VIN).

Example:
1TEST82633A123456
Example request: 
curl --request GET \
    --get "https://infoservices.guisoft.pt/api/vehicle/vin/1TEST82633A123456/mileage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
 "data": {
     "plate": "07IS81",
     "vin": "TEST82633A123456",
     "events": [
         {
             "event_date": "2015-10-13 00:00:00",
             "vehicle_mileage": 200000
         },
         {
             "event_date": "2015-03-06 00:00:00",
             "vehicle_mileage": 171000
         },
     ]
 }
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Vehicle not found"
}