Pular para o conteúdo principal
POST
/
api
/
workspace
/
{workspaceId}
/
api-keys
Create API key
curl --request POST \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "key_prefix": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "permissions": [
    "<string>"
  ],
  "last_used_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "secret": "<string>"
}

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Parâmetros de caminho

workspaceId
string
obrigatório

The workspace ID

Pattern: ^ws_[a-z0-9]+$

Corpo

application/json
name
string
obrigatório
Required string length: 1 - 255
permissions
string[]
expires_at
string<date-time> | null

Resposta

API key created successfully

id
string
obrigatório
workspace_id
string
obrigatório
name
string
obrigatório
key_prefix
string
obrigatório

First 10 characters of the API key

created_at
string<date-time>
obrigatório
permissions
string[]
last_used_at
string<date-time> | null
expires_at
string<date-time> | null
created_by
string
secret
string

Full API key (only shown on creation)

Last modified on April 13, 2026