Get started / Get started

Get started

A first call to the distributor API needs a platform and a key. Both are self-serve: you sign in at the developer console, create your platform, then create a key on the Keys page. This page walks those three steps in order.

View as .md

There is nothing to send and no form on this page. The links below open the developer console, where the three steps happen. Nothing here sends anything.

Open the developer console at developers.yutai.com and sign in with your work email. The same door creates an account if you do not hold one yet. Your sign-in is the person the console answers for; no key is needed to sign in.

Create your platform

A signed-in developer with no platform lands on Create your platform. Name the platform, pick how it holds customer accounts, add its website and contact email, and name the countries and chains it covers. One press creates the platform, your Owner seat and its distributor profile together.

Create a key

Open the Keys page and create a key: name it, pick its kind, tick the calls it may make, name the origins a publishable key presents from, and name a lapse if you want one. A secret key is shown once, when it is created, and is never shown again. A publishable key can be shown again at any time.

A new platform is self-serve. Self-serve claims work on illustrative benefits only until your platform is verified; a verified platform reaches the wider catalogue.

The key's shape

Every call presents the key in the Authorization header, as a Bearer key: Authorization: Bearer ytk_your-key. A publishable key starts with ytk_pub_ and carries 64 lowercase hex characters after it. A secret key starts with ytk_ and carries 64 lowercase hex characters after it. The placeholder ytk_your-key stands for the key you hold; no real key rides this page.

The scopes

A key carries only the calls it was asked for, each from one closed list. A publishable key can carry only the read calls: eligibility.read, availability.read, claims.read. A secret key can carry those and claims.write, connect.write, connect.read. The table below lists the scopes the documented calls present, not every scope a key may carry; each one's call is described on the API reference page:

eligibility.read: Read the benefits one or more wallets reach.
availability.read: List a security's available benefits, and read the registry's companies and instruments.
claims.write: Record a benefit claim, read a claim, reissue its link, and list and confirm fulfilments.
connect.write: Create a Connect session and unlink a customer account.
connect.read: Read Connect sessions and their outcomes.
claims.read: Read a claim and list the fulfilments waiting on the distributor.

To make your first call with the key, follow the Quickstart. When a call is refused, the Errors and limits page says what the refusal means.