Develop

Develop Boat-Tracker clients using this JSON API. The iOS, Android and web apps all use this API.

Versioning

The JSON API is versioned. Specify the API version in the Accept HTTP header. The following versions are currently supported:

The documentation covers the latest API version (v2), therefore use the following header:

Accept application/vnd.boat.v2+json

Boat-Tracker uses Google's OAuth 2.0 authentication system. Clients must

Initiate the OAuth 2.0 flow with Google
Obtain an ID token upon successful authentication with Google
Deliver the ID token to the Boat-Tracker backend when making authenticated API calls

Set the ID token in the Authorization header under the Bearer scheme:

Authorization: Bearer google_id_token_goes_here

Error responses use the following JSON format:

{
    "errors": [
        { 
            "message": "JWT expired.",
            "key": "token_expired" 
        }
    ]
}

Error keys include but are not limited to:

Key	Meaning
token_expired	The JWT has expired. The client should obtain a new one from Google and try again.
input	The client provided invalid input. Check your inputs.
generic	Most likely clients cannot recover from this.