Admin APIApi keys
Create Api Key
Create a secret or publishable API key. A secret API key is used for admin authentication. A publishable API key is used by client applications to set the scope of the request.
AuthorizationBearer <token>
In: header
Request Body
application/json
title*string
The API key's title.
type*string
The API key's type. Use secret for a user's API key; Use publishable for Publishable API keys.
Value in
"publishable" | "secret"Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X POST "https://{tenant}.api.myxclade.com/admin/api-keys" \ -H "Content-Type: application/json" \ -d '{ "title": "string", "type": "publishable" }'{
"api_key": {
"id": "string",
"token": "string",
"redacted": "sk_...123",
"title": "string",
"type": "secret",
"last_used_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"revoked_by": "string",
"revoked_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}