diff options
author | Frederic Guillot <fred@kanboard.net> | 2016-08-28 15:11:13 -0400 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2016-08-28 15:11:13 -0400 |
commit | b51c693cda1cfbda115e315de58b15c0ef275972 (patch) | |
tree | 9d46a9ddc0554c5b40de40dab69a13b1fb229284 /doc/es_ES/api-examples.markdown | |
parent | 966fe708582e426509d29a8b3ee29948cf963236 (diff) |
Merge manually PR #2614 (Spanish doc translation)
Diffstat (limited to 'doc/es_ES/api-examples.markdown')
-rw-r--r-- | doc/es_ES/api-examples.markdown | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/doc/es_ES/api-examples.markdown b/doc/es_ES/api-examples.markdown new file mode 100644 index 00000000..cba7ffe5 --- /dev/null +++ b/doc/es_ES/api-examples.markdown @@ -0,0 +1,152 @@ +Ejemplos de API +============ + +Ejemplo con cURL +----------------- + +Desde la línea de comandos: + +```bash +curl \ +-u "jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929" \ +-d '{"jsonrpc": "2.0", "method": "getAllProjects", "id": 1}' \ +http://localhost/kanboard/jsonrpc.php +``` + +Respuesta desde el servidor: + +```json +{ + "jsonrpc":"2.0", + "id":1, + "result":[ + { + "id":"1", + "name":"API test", + "is_active":"1", + "token":"6bd0932fe7f4b5e6e4bc3c72800bfdef36a2c5de2f38f756dfb5bd632ebf", + "last_modified":"1403392631" + } + ] +} +``` + +Ejemplo con Python +------------------- + +Puede utilizar el [cliente oficial Python para Kanboard](https://github.com/kanboard/kanboard-api-python): + +```bash +pip install kanboard +``` + +Aquí un ejemplo para crear un proyecto y una tarea: + +```python +from kanboard import Kanboard + +kb = Kanboard("http://localhost/jsonrpc.php", "jsonrpc", "your_api_token") + +project_id = kb.create_project(name="My project") + +task_id = kb.create_task(project_id=project_id, title="My task title") +``` + +Hay mas ejemplos en el [sitio web oficial(https://github.com/kanboard/kanboard-api-python). + +Ejemplo con un cliente PHP +------------------------- + +Puede utilizar esta [librearia Json-RPC de Cliente/servidor para PHP](https://github.com/fguillot/JsonRPC), Aqui un ejemplo: + +```php +<?php + +$client = new JsonRPC\Client('http://localhost:8000/jsonrpc.php'); +$client->authentication('jsonrpc', '19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929'); + +print_r($client->getAllProjects()); + +``` + +La respuesta: + +``` +Array +( + [0] => Array + ( + [id] => 1 + [name] => API test + [is_active] => 1 + [token] => 6bd0932fe7f4b5e6e4bc3c72800bfdef36a2c5de2f38f756dfb5bd632ebf + [last_modified] => 1403392631 + ) + +) +``` + +Ejemplo con Ruby +----------------- + +Este ejmeplo puede ser usado con Kanboard configurado con autenticación de Proxy Inverso y la API configurada con una cabecerza de autenticación personalizada: + +```ruby +require 'faraday' + +conn = Faraday.new(:url => 'https://kanboard.example.com') do |faraday| + faraday.response :logger + faraday.headers['X-API-Auth'] = 'XXX' # base64_encode('jsonrpc:API_KEY') + faraday.basic_auth(ENV['user'], ENV['pw']) # user/pass to get through basic auth + faraday.adapter Faraday.default_adapter # make requests with Net::HTTP +end + +response = conn.post do |req| + req.url '/jsonrpc.php' + req.headers['Content-Type'] = 'application/json' + req.body = '{ "jsonrpc": "2.0", "id": 1, "method": "getAllProjects" }' +end + +puts response.body +``` + + +Ejemplo con Java +----------------- + +Este es un ejemplo basico usando Spring. Para su uso correcto vea [Este enlace](http://spring.io/guides/gs/consuming-rest). + +```java +import java.io.UnsupportedEncodingException; +import java.util.Base64; + +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.web.client.RestTemplate; + +public class ProjectService { + + public void getAllProjects() throws UnsupportedEncodingException { + + RestTemplate restTemplate = new RestTemplate(); + + String url = "http://localhost/kanboard/jsonrpc.php"; + String requestJson = "{\"jsonrpc\": \"2.0\", \"method\": \"getAllProjects\", \"id\": 1}"; + String user = "jsonrpc"; + String apiToken = "19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929"; + + // encode api token + byte[] xApiAuthTokenBytes = String.join(":", user, apiToken).getBytes("utf-8"); + String xApiAuthToken = Base64.getEncoder().encodeToString(xApiAuthTokenBytes); + + // consume request + HttpHeaders headers = new HttpHeaders(); + headers.add("X-API-Auth", xApiAuthToken); + headers.setContentType(MediaType.APPLICATION_JSON); + HttpEntity<String> entity = new HttpEntity<String>(requestJson, headers); + String answer = restTemplate.postForObject(url, entity, String.class); + System.out.println(answer); + } +} +``` |