Po.et Documentation
Technical documentation for the Po.et Network

About Po.et
Use Po.et
Reference
Process
RDD

Po.et API

We are using the OpenAPI specification to document the Po.et API:
https://app.swaggerhub.com/apis-docs/po.et/poet-api/0.1.0/

The purpose of the API is to:

Tokens

There are four types of tokens generated by the API. The two main ones used in the API methods described below are:

There are two other tokens sent by email:

Health check

Accounts

Create account

Returns a Login token.

Verify account

When the user creates a new account the system automatically sends an email for the purpose of verifying the email address. This email contains a link with an embedded token, which the user only needs to click in order to verify the email address. Alternatively, the token can be passed programatically to the server.

Resend verification email

Requires a Login token.

Login to account

Authenticate with email address and password.

Returns a Login token.

Get account profile

Requires a Login token.

Password reset

When the user forgets or loses the account password, a new one can be requested programatically. An email is sent that contains a link with an embedded token, which the user can click in order to set a new password.

Password change

Requires a Login token.

Password change token

Requires a Forgot Password token.

Tokens

Create token

Requires a Login token.

Returns a “test” or “live” API token.

Get tokens

Requires a Login token.

Delete token

Requires a Login token.

Works

Create work

Requires an API token.

Get all works

Requires an API token.

Get work

Requires an API token.