reference

Authentication and Reference

2 endpoints

Auth

POST/api/v3/auth

Auth API Token

no token needed

Exchanges the API user's accessKey and secret for a token. On success the token comes back in the X-AUTH-TOKEN response header; send it in a header of the same name on every other call.

Request body

ApiLoginDto

accessKey string
secret string

Responses

200 OK

object

Request

curl -X POST 'https://app.wxrks.com/api/v3/auth' \
  -H 'Content-Type: application/json' \
  -d '{
  "accessKey": "string",
  "secret": "string"
}'

Locale

GET/api/v3/language

List Languages

query parameters

orgUnitUuid string (uuid)

Responses

200 OK

Language[]

coderequired string
id integer (int64)
namerequired string

Request

curl -X GET 'https://app.wxrks.com/api/v3/language' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "code": "string",
    "id": 0,
    "name": "string"
  }
]