summaryrefslogtreecommitdiff
path: root/doc/api-examples.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-examples.markdown')
-rw-r--r--doc/api-examples.markdown56
1 files changed, 12 insertions, 44 deletions
diff --git a/doc/api-examples.markdown b/doc/api-examples.markdown
index 9b1ed12a..14d5db98 100644
--- a/doc/api-examples.markdown
+++ b/doc/api-examples.markdown
@@ -34,62 +34,30 @@ Response from the server:
Example with Python
-------------------
-Here a basic example written in Python to create a task:
+You can use the [official Python client for Kanboard](https://github.com/kanboard/kanboard-api-python):
-```python
-#!/usr/bin/env python
-
-import requests
-import json
-
-def main():
- url = "http://demo.kanboard.net/jsonrpc.php"
- api_key = "be4271664ca8169d32af49d8e1ec854edb0290bc3588a2e356275eab9505"
- headers = {"content-type": "application/json"}
-
- payload = {
- "method": "createTask",
- "params": {
- "title": "Python API test",
- "project_id": 1
- },
- "jsonrpc": "2.0",
- "id": 1,
- }
+```bash
+pip install kanboard
+```
- response = requests.post(
- url,
- data=json.dumps(payload),
- headers=headers,
- auth=("jsonrpc", api_key)
- )
+Here an example to create a project and a task:
- if response.status_code == 401:
- print "Authentication failed"
- else:
- result = response.json()
+```python
+from kanboard import Kanboard
- assert result["result"] == True
- assert result["jsonrpc"]
- assert result["id"] == 1
+kb = Kanboard("http://localhost/jsonrpc.php", "jsonrpc", "your_api_token")
- print "Task created successfully!"
+project_id = kb.create_project(name="My project")
-if __name__ == "__main__":
- main()
+task_id = kb.create_task(project_id=project_id, title="My task title")
```
-Run this script from your terminal:
-
-```bash
-python jsonrpc.py
-Task created successfully!
-```
+There are more examples on the [official website](https://github.com/kanboard/kanboard-api-python).
Example with a PHP client
-------------------------
-I wrote a simple [Json-RPC Client/Server library in PHP](https://github.com/fguillot/JsonRPC), here an example:
+You can use this [Json-RPC Client/Server library for PHP](https://github.com/fguillot/JsonRPC), here an example:
```php
<?php