Skip to content

API Definitions

Mauro Calvi edited this page Jun 25, 2018 · 3 revisions

Unique identifiers

When requesting a sQuiddio object, the following id constructs are available:

Vessel object

Use either of the following:

squiddio:vesselId:[squiddio vessel id]

imo:mmsi:[mmsi]

Special values:

SELF: the sQuidd.io vessel associated with the request's access_tok1en.

Examples:

Request Vessel profile for S/V Bella Vita:

https://squidd.io/apps/v1/api/vessels/squiddio:vesselId:1

or

https://squidd.io/apps/v1/api/vessels/imo:mmsi:338197303

or, for your boat:

https://squidd.io/apps/v1/api/vessels/self

Point of Interest (POI)

Use:

squiddio:poiID:[squiddio place id]

Examples:

Request POI information for the Treasure Island Marina, San Francisco:

https://squidd.io/apps/v1/api/resources/squiddio:poiId:1492

Note: you can find the squiddio place ID in the squiddio URL of the place, e.g. https://squidd.io/places/1492

User

Use:

squiddio:userId:[squiddio user id]

Special Values:

ME: the sQuidd.io user who owns the SELF vessel

Examples:

Request your own user profile

https://squidd.io/apps/v1/api/users/me

Clone this wiki locally