Bullseye

STREAM
Correction as a Service

Authentication

In order to use the Correction API, you must request an access token. This is done by making an OAuth request using your MapQuest key and secret.

Resource URL

https://www.mapquestapi.com/oauth/token

Form Data

Parameter Description
client_id The application "Consumer Key".
client_secret The application "Consumer Secret".

Response

Response Field Description
clientId The id of the client making the request. The same as the value provided in the request form.
accessToken The token to use when interacting with the correction api.
expiresIn The time this token will expire in seconds.
issuedAt The timestamp this token was issued.
tokenType Typically "BearerToken".
bullseyeUrl The url that will accept the provided access_token.
bullseyeClientIp The ip of the client requesting access.

When the token expires

The tokens obtained from the OAuth endpoint is set to expire after a certain period. When this happens, you must obtain a new token by rerunning the above steps.

Correction API

Resource URL

http://caas.hyperlocation.io:2101/MOUNTPOINT_NAME

Resource URL Data

Parameter Description
mountpoint_name The customer specific "Mountpoint Name".

Request Headers

Header Parameter Description Required?
Authorization

Example

Authorization: Bearer ACCESS_TOKEN

Yes
Ntrip-GGA An Ntrip string representing the observed location from a device.

Example

Ntrip-GGA: $GPGGA,163601.70,3316.1098032,N,09709.6827232,W, 1,00,1.0,207.656,M,-27.689,M,0.0,*73

See also

Ntrip Strings

Yes

Response

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: gnss/data

Obtaining an Access Token

Example cURL Request

curl -v -H "Content-Type:application/x-www-form-urlencoded" \
  https://www.mapquestapi.com/oauth/token \
  -d "client_id=CLIENT_ID&client_secret=CLIENT_SECRET"

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "clientId": "CLIENT_ID",
  "accessToken": "ACCESS_TOKEN",
  "expiresIn": "7199",
  "issuedAt": "1506527634471",
  "tokenType": "BearerToken",
  "bullseyeUrl": "http://caas.hyperlocation.io:2101",
  "bullseyeClientIp": "CLIENT_IP"
}

Getting Correction

Example cURL Request

curl -X GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  --header "Ntrip-GGA: \
  $GPGGA,163601.70,3316.1098032,N,09709.6827232,W,1,00,1.0,207.656,M,-27.689,M,0.0,*73" \
  http://caas.hyperlocation.io:2101/MOUNTPOINT_NAME

Example cURL Response

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: gnss/data
<binary data stream>