# API documentation in the console

A read-only reference page explaining how to connect third-party software to the partner API.

Source: https://docs.sealtrust.io/en/console/documentation-api/

---

This screen gathers what your technical team needs in order to call the partner API from its own software: base address, key authentication, batch product creation, webhooks and code samples. It sends no call and shows no data belonging to your brand. You open it to connect an external tool, or when a call has been refused and you are looking for the rule behind the refusal.

![The partner API documentation page in the console, with its tabs and code blocks](/console/documentation-api.en.webp)

## What the screen shows

The title "Partner API Documentation" and an introductory sentence. The labels on this page are in English.

A "Base URL" card carrying `https://api.sealtrust.io`, followed in brackets by the development address `http://localhost:8000`.

Five tabs: Quick Start, Authentication, Batch Mint, Webhooks, SDK Examples.

Lists of endpoints, each with its verb in colour, GET in blue, POST in green, PUT in amber, DELETE in red, and, for those that require one, the scope shown as a pill.

A table of key properties: `brand_id`, `scopes`, `quota_per_day`, `expires_at`. The quota is counted in products: one batch creation call carrying 500 products consumes 500 units, and `null` means unlimited.

An error table announcing three codes only: 401 for a missing or invalid key, 403 for an expired or revoked key, or one with insufficient scopes, 429 for the per-minute limit or the daily quota. The `X-RateLimit-*` headers accompany every response, the `X-Quota-*` headers only the 429 that has already refused the call.

A table of webhook events, from `product.minted` to the `buyback.*` events.

Code blocks for curl, Python and TypeScript, each with its copy button, and amber panels stating the server rules.

## What you can do here

Switch between the five tabs. Quick Start is the one shown on opening.

Copy a code block in one click: the icon turns into a tick for 2 seconds, then reverts.

Open the API keys page through the "API Keys" link in step 1.

## What governs access

Your plan must include the `api_access` feature.

You must be signed in and an administrator. Otherwise the console replaces the page with "Unauthorized. Please log in at www.sealtrust.io." and a sign-in button.

The "API Documentation" entry in the side menu carries no feature key: it stays visible and clickable even when the page behind it is blocked.

## What the screen refuses

Without `api_access` in your plan, the whole page is replaced by three lines: "Feature unavailable", "This feature is not included in your current plan." and an invitation to contact SealTrust for an upgrade.

A batch of more than 500 products is refused with a 400, the message carrying the number received and the limit.

Deleting a webhook subscription without confirmation is refused with a 400, code `CONFIRMATION_REQUIRED`, and with a wrong confirmation with a 400, code `CONFIRMATION_MISMATCH`. In both cases nothing is deleted.

An event absent from the table is rejected at subscription time. `product.verified` and `certificate.revoked` never existed.

A webhook address must use HTTPS. An unknown field in the body returns a 422.

The screen itself announces that Swagger UI is available in development, and gives its address.