API docs by Redocly

Send My Signals (1.0)

Download OpenAPI specification:Download

Authentication

Request an access token using OAuth 2.0 Client Credentials flow.

Overview

This endpoint implements the OAuth 2.0 Client Credentials grant type.

Authentication Flow

  1. Make a POST request to this endpoint with your client credentials
  2. Receive an access token in the response
  3. Use the access token in the Authorization header for subsequent API calls

Security Notes

  • Never expose your client_secret in client-side code or public repositories
  • Store credentials securely using environment variables or secret management systems
  • Implement token caching to minimize token requests
Authorizations:
BearerAuth
Request Body schema: application/json
required

OAuth 2.0 client credentials

client_id
required
string

Your OAuth 2.0 client identifier provided by WAKEO

client_secret
required
string

Your OAuth 2.0 client secret provided by WAKEO. Keep this confidential!

audience
required
string
Value: "https://api.gpsa.road.wakeo.co"

The API audience for the resource server

grant_type
required
string
Value: "client_credentials"

OAuth 2.0 grant type. Must be "client_credentials"

Responses

Request samples

Content type
application/json
{
  • "client_id": "<<your_client_id_here>>",
  • "client_secret": "<<your_client_secret_here>>",
  • "audience": "https://api.gpsa.road.wakeo.co",
  • "grant_type": "client_credentials"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJSUzI1NiIsInR5c...",
  • "token_type": "Bearer",
  • "expires_in": 2592000
}

Send signals

Send your GPS signals to WAKEO.

Important Notes

💡 To optimize the processing of your signals, we recommend that you send them in batches

‼️ The total size must be ≤1MB; this corresponds to roughly 4000 signals

⚠️ In one batch, be sure you send only 1 signal per device/truck

Authorizations:
BearerAuth
Request Body schema: application/json
required

The signals you want to send to WAKEO. The total size must be ≤1MB; this corresponds to roughly 4000 signals.

Array
latitude
required
number <double> [ -90 .. 90 ]

The latitude coordinate of the signal position.

longitude
required
number <double> [ -180 .. 180 ]

The longitude coordinate of the signal position.

licensePlate
required
string^[^ -]+$

The license plate of the truck which sent the signal.

positionTimestamp
required
string <date-time>

The time at which the signal was recorded by the telematics device. Note that the format of the timestamp is according to RFC 3339, section 5.6. This means that the timezone of the timestamp is included in the string. For example, the string "2017-07-21T17:32:28Z" encodes the time July 21, 2017, 17:32:28 in the UTC timezone (indicated by the "Z").

deviceId
string

Your identifier for the device that produced this signal. This value is used by WAKEO to identify signals originating from the same device. If absent, WAKEO will use licensePlate to identify the device producing the signal.

object

An arbitrary object containing metadata that you would like to provide to applications receiving this signal via the Receive My Signals service. The UTF-8 representation of the object must have size at most 10KB.

references
Array of strings

An optional list of reference-strings that are intended to help receivers of this signal associate it with other objects. For example, a reference could be the identifier of the transport order that the truck to which this signal belongs is currently executing.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]