Create Thryve user

When you integrate Thryve with your web application, you will need to first create a Thryve user. All data connections and data stored at Thryve are always linked to a Thryve user. Unlike mobile apps using the Thryve SDK, where user management is handled automatically, web applications need to manually create a new user or retrieve an existing one using the accessToken interface.

Please note that accessToken/authenticationToken is used synonymous to endUserId and is used in the Thryve API v5. The same is true for partnerUserId and endUserAlias parameters. With the introduction of Thryve API v6, all interfaces will migrate to use endUserId and endUserAlias.

We recommend setting an alias for the Thryve user. We call this the partnerUserID. (or endUserAlias ). Please ensure that the alias is an unguessable string generated, e.g., through a hash function. We suggest at least 32 digits, which may contain both digits, characters, and a dash „-„, as a special character. A partnerUserID can have a maximum length of 80 characters.

Get accessToken of new or existing user

post

Retrieve an accessToken for a Thryve user. Automatically creates a user if partnerUserID is empty or no existing user with specified partnerUserID exists.

Header parameters

AuthorizationstringRequired

Basic Auth for your username:password. Required for all endpoints

Example: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

AppAuthorizationstringRequired

Basic Auth for your authID:authSecret. Required for all endpoints.

Example: Basic YXV0aElEOmF1dGhTZWNyZXQ=

Body

application/x-www-form-urlencoded

partnerUserIDstringOptional

Set this optional parameter to add your an alias to a Thryve user. If no alias is set, it is not possible to retrieve an accessToken/authenticationToken for an existing user. Newer interfaces call this parameter endUserAlias.

Example: FVMW6fp9wnUxKnfekrQduZ96Xt6gemVk

Responses

200

Request successful. Returns the accessToken of a user.

text/plain

ResponsestringExample: de3d1e068537dd927b48988cb6969abe

400

Error response (invalid parameters, unauthorized, etc.).

application/json

post

/v5/accessToken

HTTPcURLJavaScriptPython

POST /v5/accessToken HTTP/1.1
Host: api.thryve.de
Authorization: text
AppAuthorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 52

"partnerUserID='FVMW6fp9wnUxKnfekrQduZ96Xt6gemVk'"

de3d1e068537dd927b48988cb6969abe