diff options
| -rw-r--r-- | doc/es_ES/api-authentication.markdown | 60 | ||||
| -rw-r--r-- | doc/es_ES/api-comment-procedures.markdown | 181 |
2 files changed, 241 insertions, 0 deletions
diff --git a/doc/es_ES/api-authentication.markdown b/doc/es_ES/api-authentication.markdown new file mode 100644 index 00000000..0612ffee --- /dev/null +++ b/doc/es_ES/api-authentication.markdown @@ -0,0 +1,60 @@ +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](http://www.ietf.org/rfc/rfc2617.txt). + + +Modificar el header HTTP +------------------------ + +Se puede usar un header HTTP alternativo para la autentificación si tu servidor es muy especifico + +configuration. + +- El nombre del header puede ser cualquier cosa que desee, por ejemplo `X-API-Auth`. +- El valor del header `username:password` esta codificado en Base64. + +Configuración: + +1. Definir tu header personalizado en tu `config.php`: `define('API_AUTHENTICATION_HEADER', 'X-API-Auth');` +2. Codificar las credenciales en Base64, ejemplo con PHP `base64_encode('jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929');` +3. Verificar con curl + +```bash +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 +---------------------- + +Si el usuario conectado no tiene permiso para acceder al recurso , recibirá un `403 Forbidden`. diff --git a/doc/es_ES/api-comment-procedures.markdown b/doc/es_ES/api-comment-procedures.markdown new file mode 100644 index 00000000..81389892 --- /dev/null +++ b/doc/es_ES/api-comment-procedures.markdown @@ -0,0 +1,181 @@ +API Procedimientos de comentarios +====================== + +## createComment [Crear un comentario] + +- Propósito: **Crear un nuevo comentario** +- Parametros: + - **task_id** (integer, required) + - **user_id** (integer, required) + - **content** Reducción de contenido (string, required) +- Resultado satisfactorio: **comment_id** +- Resultado fallido : **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "createComment", + "id": 1580417921, + "params": { + "task_id": 1, + "user_id": 1, + "content": "Comment #1" + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 1580417921, + "result": 11 +} +``` + +## getComment [Obtener un comentario] + +- Propósito: **Obtener la información del comentario** +- Parametros: + - **comment_id** (integer, required) +- Resultado satisfactorio: **propiedades del comentario** +- Resultado fallido: **null** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "getComment", + "id": 867839500, + "params": { + "comment_id": 1 + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 867839500, + "result": { + "id": "1", + "task_id": "1", + "user_id": "1", + "date_creation": "1410881970", + "comment": "Comment #1", + "username": "admin", + "name": null + } +} +``` + +## getAllComments [Obtener todos los comentarios] + +- Proposito: **Obtener todos los comentarios disponibles** +- Parametros: + - **task_id** (integer, required) +- Resultado satisfactorio: **Lista de comentarios** +- Resultado fallido : **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "getAllComments", + "id": 148484683, + "params": { + "task_id": 1 + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 148484683, + "result": [ + { + "id": "1", + "date_creation": "1410882272", + "task_id": "1", + "user_id": "1", + "comment": "Comment #1", + "username": "admin", + "name": null + }, + ... + ] +} +``` + +## updateComment [Actualizar un comentario] + +- Proposito: **Actualizar un comentario** +- Parametros: + - **id** (integer, required) + - **content** Reducción de contenido (string, required) +- Resultado satisfactorio: **true** +- Resultado fallido: **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "updateComment", + "id": 496470023, + "params": { + "id": 1, + "content": "Comment #1 updated" + } +} +``` + +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 1493368950, + "result": true +} +``` + +## removeComment [Eliminar un comentario] + +- Proposito : **Eliminar un comentario** +- Parametros: + - **comment_id** (integer, required) +- Resultado satisfactorio: **true** +- Resultado fallido: **false** + +Ejemplo de petición: + +```json +{ + "jsonrpc": "2.0", + "method": "removeComment", + "id": 328836871, + "params": { + "comment_id": 1 + } +} +``` +Ejemplo de respuesta: + +```json +{ + "jsonrpc": "2.0", + "id": 328836871, + "result": true +} +``` |