> ## Documentation Index
> Fetch the complete documentation index at: https://docs.digitalseaservice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DSS Public API

> Read a crew member's verified Digital Sea Service record — sea time, vessel history, profile — with their OAuth consent.

The DSS Public API lets approved partner platforms display a crew member's
Digital Sea Service record alongside their own product, with the crew member's
explicit consent. It's a thin, read-only REST API behind an OAuth 2.0
Authorization Code flow with PKCE.

If you've integrated with Stripe, Plaid, or Google sign-in before, the shape
will be familiar.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Zero to a successful `/v1/me` call in 15 minutes.
  </Card>

  <Card title="Authentication" icon="lock" href="/authentication">
    OAuth 2.0 + PKCE, end-to-end, with samples.
  </Card>

  <Card title="API reference" icon="code" href="/api-reference">
    Auto-generated from our live OpenAPI 3.1 spec.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/webhooks/overview">
    Signed, retried event delivery when records change.
  </Card>
</CardGroup>

## Base URLs

| Environment | Base URL |
| - | - |
| Production | `https://api.digitalseaservice.com` |
| Sandbox | `https://api.dev.digitalseaservice.com` |

The sandbox is a fully isolated environment with seeded test crew records.
Sandbox credentials are issued immediately on partner onboarding; production
credentials follow integration review.

## What's in V1

* **OAuth 2.0 Authorization Code + PKCE** — single canonical flow for every
  partner. No API keys, no client credentials.
* **Opaque tokens** stored server-side. Revocation is instant.
* **Three read scopes** — `profile:read`, `seatime:read`, `vessels:read`.
* **Four read endpoints** — `/v1/me`, `/v1/me/sea-time`,
  `/v1/me/sea-time/recent`, `/v1/me/vessels`.
* **Signed, retried webhooks** with a 5-minute replay window and a documented
  retry schedule.
* **Conditional GETs** — `ETag` + `If-Modified-Since` on every resource for
  cheap polling.
* **Cursor pagination** — stable under concurrent writes.
* **RFC 7807 Problem Details** errors with a `type:` URL that resolves into
  these docs.

## What's not in V1

These are deliberately out of scope so we don't paint ourselves into a corner.
If your integration needs any of them, [get in
touch](mailto:admin@digitalseaservice.com).

* Write endpoints (e.g. partner logging sea time on a user's behalf).
* Multi-user / fleet endpoints.
* Self-serve partner registration.
* Certificates / reports.
* SDKs — partners hit REST directly.

## OpenAPI

The live spec is served from the API itself, prominently:

* [`https://api.digitalseaservice.com/openapi.json`](https://api.digitalseaservice.com/openapi.json)
* [`https://api.digitalseaservice.com/openapi.yaml`](https://api.digitalseaservice.com/openapi.yaml)

A snapshot is also available at
[`/api-reference/openapi.json`](/api-reference/openapi.json) on this docs site,
which is what the [API reference](/api-reference) tab is built from.

## Built for AI agents too

These docs are designed to be ingested by AI coding agents — Claude, Cursor,
Copilot — as easily as by humans. Every page is available as raw markdown by
appending `.md` to its URL (e.g.
[`/quickstart.md`](https://docs.digitalseaservice.com/quickstart.md)), there's
an [`llms.txt`](https://docs.digitalseaservice.com/llms.txt) manifest at the
root, and a single
[`llms-full.txt`](https://docs.digitalseaservice.com/llms-full.txt) bundle of
every page concatenated, ready to drop into a model's context.

## Support

* Email — [admin@digitalseaservice.com](mailto:admin@digitalseaservice.com).
  One address for everything: technical questions, partner onboarding, and
  sandbox/production credential requests.
* Status — [status.digitalseaservice.com](https://status.digitalseaservice.com)
* Every API response carries an `X-Request-Id`. Include it when you write in
  and we can pull the exact log entry.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.