Build on boating.systems
For a club, a business or one person who needs something we don't do
boating.systems apps cover planning, logs, boats, races and clubs. When someone needs more, like a club's own sign-up, a rental desk or a gear-swap board, they can build an app that works with their members' boating.systems accounts. People connect it with their permission, and only for what they allow. To use boating.systems from your own AI instead, see the connector.
How it works
- Register at account.boating.systems/developers (or the test project, account-boating-dev.web.app/developers, with separate accounts and data). You get an app id and a client secret for your server.
- A person connects through OAuth 2.0 authorization code with PKCE (S256) at
https://account.boating.systems/connect. They see your app, what it asks for and what you say you keep, and they allow or cancel. Tokens come fromhttps://account.boating.systems/api/oauth/token. - People are subject ids, stable in your app and unrelated across apps. You never get a platform id, an email address or a phone number.
- You call functions for that person at
https://us-central1-boating-platform-prod.cloudfunctions.net/<name>with their access token:vesselBorrows(lending),orgRequirements,vesselGuestbook,exchangeReferencesandappData. Each call re-reads their permission; a refused call means they took it back. - Read the revocation feed (
/api/oauth/revocations) at least daily, and delete what you keep about a disconnected person within 30 days. - Stages: a new app is in development, so only you and testers you name can connect. We review it before it is open to everyone.
What an app may ask for
Each is a separate permission on the consent page, in these words:
identity: see their first namelending.borrow: book, collect and return boats lent to them, and see lock codes during their bookingslending.host: lend boats they manage: who may borrow, the lock, and who has themrequirements.take: take the pledges and courses a boat's owner asks forrequirements.manage: write pledges and courses for organizations they runguestbook.write: add notes they choose to a boat's guestbook, and remove themreferences: write and read references for their borrowsapp_data: keep your app's own settings with their account (16 KB, never ids, contact details, positions or secrets)plan.read,plan.draft,trips.invite,boats.manage,boats.gear,boats.care,boats.status,marina.read,marina.office,places.suggest,log.read,log.write,launches.report,people.read: the actions the AI connector uses. An app may ask for them after review.
The data rules
- Never copy: a person's platform id, contact details, raw tracks or positions beyond what a share shows, lock codes, safety data, other people's data beyond what an answer shows, organization rosters.
- Cache briefly (24 hours, for display and offline use): offers, bookings, guestbook entries, requirement text.
- Keep while connected: what the person made in your app, their subject id, your app's settings for them.
- Keep: aggregates with no person in them.
The client package
@boating-systems/connect holds the typed contract (every request and answer), the PKCE and token helpers,
the revocation reader and the data policy. It is not on the public npm registry yet: write to
info@boating.systems for access, or build from the description above.
import { PRODUCTION, authorizeUrl, pkce, newState, readCallback, requestToken, codeTokenRequest, call, LENDING_FUNCTION, lending } from '@boating-systems/connect';
Ask first
Not sure whether what you need fits? Write to info@boating.systems. Things many people ask for may become part of the apps.