Kanboard-Prod/doc/api-authentication.markdown

API de autentificación

API endpoint

URL: https://YOUR_SERVER/jsonrpc.php

Metedo por default (HTTP Basico)

Aplicación de credenciales

• Username: jsonrpc
• Password: API token para la configuración de pagina

Credencial de usuario

• Usar el usuario real y su password

La API usa la Autentificación Basica del esquema HTTP descrita en el RFC2617.

Modificar el header HTTP

Se puede usar un hedear HTTP alternativo para la autentificación si tu servidor es muy especifico You can use an alternative HTTP header for the authentication if your server have a very specific configuración. configuration.

• The header name can be anything you want, by example X-API-Auth.
• The header value is the username:password encoded in Base64.

Configuración:

1. Definir tu cabecera modificada en tu config.php: define('API_AUTHENTICATION_HEADER', 'X-API-Auth');
2. Define your custom header in your config.php: define('API_AUTHENTICATION_HEADER', 'X-API-Auth');
3. Codificar las credenciales en Base64, ejemplo con PHP
4. Encode the credentials in Base64, example with PHP base64_encode('jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929');
5. Verificar con curl
6. Test with curl:

curl \
-H 'X-API-Auth: anNvbnJwYzoxOWZmZDk3MDlkMDNjZTUwNjc1YzNhNDNkMWM0OWMxYWMyMDdmNGJjNDVmMDZjNWIyNzAxZmJkZjg5Mjk=' \
-d '{"jsonrpc": "2.0", "method": "getAllProjects", "id": 1}' \
http://localhost/kanboard/jsonrpc.php

Error de autentificación

Authentication error

Si las credenciales son , recibiras un 401 Not Authorized y el correspondiente respuesta del JSON. If the credentials are wrong, you will receive a 401 Not Authorized and the corresponding JSON response.

Error de Autorización

Authorization error

Si el usuario no , recibira un 403 Forbidden. If the connected user is not allowed to access to the resource, you will receive a 403 Forbidden.