Table of Contents
URL: https://YOUR_SERVER/jsonrpc.php
jsonrpc
The API use the HTTP Basic Authentication Scheme described in the RFC2617.
You can use an alternative HTTP header for the authentication if your server have a very specific configuration.
X-API-Auth
.username:password
encoded in Base64.Configuration:
config.php
:
define('API_AUTHENTICATION_HEADER', 'X-API-Auth');
base64_encode('jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929');
curl \
-H 'X-API-Auth: anNvbnJwYzoxOWZmZDk3MDlkMDNjZTUwNjc1YzNhNDNkMWM0OWMxYWMyMDdmNGJjNDVmMDZjNWIyNzAxZmJkZjg5Mjk=' \
-d '{"jsonrpc": "2.0", "method": "getAllProjects", "id": 1}' \
http://localhost/kanboard/jsonrpc.php
If the credentials are wrong, you will receive a 401 Not Authorized
and the corresponding JSON response.
If the connected user is not allowed to access to the resource, you will
receive a 403 Forbidden
.