Overview

#Keep in mind

One address

https://dev.mod.wtf/api/v2/action for every action.

Software Owner keys

Calls run as the owner of the API key, see authentication.

Several software

soft_id takes any software you own. Actions without a required soft_id use your main software unless you pass one.

Never cached

Answers are sent with Cache-Control: no-store and X-Content-Type-Options: nosniff.

Stable codes

Failures carry a machine-readable error, listed on errors.

#Request shape

{
    "api_key": "YOUR_API_KEY",
    "method": "get-key",
    "soft_id": 123,
    "key": "KEY-EXAMPLE"
}

curl -sS -X POST 'https://dev.mod.wtf/api/v2/action' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "YOUR_API_KEY",
    "method": "get-key",
    "soft_id": 123,
    "key": "KEY-EXAMPLE"
}'

POST /api/v2/action HTTP/1.1
Host: dev.mod.wtf
Content-Type: application/json
Accept: application/json

{
    "api_key": "YOUR_API_KEY",
    "method": "get-key",
    "soft_id": 123,
    "key": "KEY-EXAMPLE"
}

#Response shape

{
    "ok": true,
    "data": {
        "key": "KEY-EXAMPLE",
        "max_devices": 1
    }
}

{
    "ok": false,
    "error": "not_found",
    "message": "key not found"
}

#Every action

#Machine-readable