Skip to navigation

Create a publishable key

The key for your web page (the @rydhm/web SDK). It works only from allowedOrigins, so list every website your app runs on. At most 10 live keys per expert.

Sessions: admins.

Needs the experts:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The expert id.

Request

This endpoint expects an object.
allowedOriginslist of stringsRequired
The websites the key works on. An empty list refuses every browser.
namestringOptional<=80 characters
requireSignedUserbooleanOptional

Response

OK
idstring
A UUID.
agentIdstring
A UUID.
keystring

rydhm_pk_live_ followed by 24 letters and digits.

namestring
allowedOriginslist of strings
requireSignedUserboolean

Only signed users (user.id with user.hash) may use it.

createdAtdatetime
revokedAtdatetime or nullOptional
lastUsedAtdatetime or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error