Skip to content
v1.0.0
OAS 3.0.1

Stripo Authentication API

The Stripo Plugin requires an authentication token to perform any operations.

To authenticate your instance of the Stripo Plugin, call the provided endpoint with your Plugin ID and Secret Key. Ensure you include the userId of the user who will be working within the plugin, along with their role. The list of supported roles can be found here

Server:
Client Libraries

Methods

Methods Operations

Get authentication token

Body
required
application/json
  • plugin​Id
    Type: string
    required

    The value from your plugin configuration page

  • role
    Type: stringenum
    required

    String value of a user role in the editor. For example, "ADMIN", "USER" or "API". Use "API" value for backend-to-backend requests

    • ​A​D​M​I​N
    • ​U​S​E​R
    • ​A​P​I
  • secret​Key
    Type: string
    required

    The value from your plugin configuration page

  • user​Id
    Type: string
    required

    String value of a user identifier

Responses
  • 200
    Type: object
    • token
      Type: string
      required

      Authentication token for the editor

Request Example for post/api/v1/auth
curl /api/v1/auth \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "pluginId": "PID123456",
  "secretKey": "SK654321",
  "userId": "1",
  "role": "USER"
}'
{
  "token": "TK123456"
}

Models