Version 1¶
Schema¶
All API access should over HTTPS, and accessed the https://YOUR_CLOUD/index.php/apps/ojsxc/ajax/
.
All data is sent and received as JSON. Every request has to contain a signature to verify the request.
Client Errors¶
- 500 Internal Server Error:
{"result": "error", "data": {"msg":"An error occured"}}
Header Signature¶
Every request to an API endpoint needs a valid X-JSXC-SIGNATURE header of the
form HASH_ALGO=hmac(HASH_ALGO, REQUEST_BODY, API_SECRET)
.
Endpoints¶
Check Password¶
POST /externalApi.php
Parameters¶
Name | Type | Description |
---|---|---|
operation | “checkPassword” | |
username | string | |
password | string | |
domain | string | The domain is used to check additionally
the password for username@domain (optional) |
Response¶
Status: 200 OK
{
"result": "noauth"
}
Status: 200 OK
{
"result": "success",
"data": {
"uid": "foobar"
}
}