Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/binwiederhier/json-rpc-demo
Demo API for Datto JSON-RPC libraries
https://github.com/binwiederhier/json-rpc-demo
Last synced: 24 days ago
JSON representation
Demo API for Datto JSON-RPC libraries
- Host: GitHub
- URL: https://github.com/binwiederhier/json-rpc-demo
- Owner: binwiederhier
- License: apache-2.0
- Created: 2015-12-28T23:05:49.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2015-12-30T21:44:54.000Z (almost 9 years ago)
- Last Synced: 2024-10-05T06:30:55.167Z (about 1 month ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JSON-RPC Example Project
========================
To test, init composer and start a webserver
--------------------------------------------
```bash
$ composer install
$ php -S localhost:8888
```
Example 1: Using `JsonRpc\Simple` mapper
----------------------------------------
HTTP-only endpoint without authentication, logging or validation.
```bash
# Adding a device
curl -d '{"jsonrpc":"2.0","id":1,"method":"devices/add","params":{"name":"Philipp PC","type":"pc"}}' http://localhost:8888/example1/api.php; echo
{"jsonrpc":"2.0","id":1,"result":{"id":0,"name":"Philipp PC","type":"pc"}}
# Listing all devices
$ curl -d '{"jsonrpc":"2.0","id":1,"method":"devices/listAll"}' http://localhost:8888/example1/api.php; echo
{"jsonrpc":"2.0","id":1,"result":[{"id":0,"name":"Philipp PC","type":"pc"}]}
```
Example 2: Adding parameter validation with `JsonRpc\Validator`
---------------------------------------------------------------
```bash
$ curl -d '{"jsonrpc":"2.0","id":1,"method":"devices/listAll","params":{"sortBy":"INVALID"}}' http://localhost:8888/example2/api.php; echo
{"jsonrpc":"2.0","id":1,"error":{"code":-32602,"message":"Invalid params"}}
```
Example 3: Adding HTTP Basic authentication with `JsonRpc\Auth`
---------------------------------------------------------------
Trying to access API without authentication:
```bash
$ curl -d '{"jsonrpc":"2.0","id":1,"method":"devices/listAll"}' http://localhost:8888/example3/api.php; echo
{"jsonrpc":"2.0","id":1,"error":{"code":-32651,"message":"Missing auth."}}
```
Trying to access API with invalid Basic Auth credentials:
```bash
$ curl -u invaliduser:pass -d '{"jsonrpc":"2.0","id":1,"method":"devices/listAll"}' http://localhost:8888/example3/api.php; echo
{"jsonrpc":"2.0","id":1,"error":{"code":-32652,"message":"Invalid auth."}}
```
Access API via HTTP (authenticated via HTTP Basic Auth):
```bash
$ curl -u user:pass -d '{"jsonrpc":"2.0","id":1,"method":"devices/listAll"}' http://localhost:8888/api.php; echo
{"jsonrpc":"2.0","id":1,"result":[{"name":"a","age":51,"posts":1881},{"name":"aaron","age":31,"posts":111},{"name":"chris","age":51,"posts":1881},{"name":"phil","age":29,"posts":999}]}
```
Example 4: Adding logging with `JsonRpc\Logged`
------------------------------------------------
Requests and responses are logged to syslog (usually at `/var/log/syslog`):
```bash
# Do a request first
$ curl -u user:pass -d '{"jsonrpc":"2.0","id":1,"method":"devices/listAll"}' http://localhost:8888/example4/api.php; echo
{"jsonrpc":"2.0","id":1,"result":[{"id":0,"name":"Philipp PC","type":"pc"}]}
# Then check syslog (on the server)
$ tail /var/log/syslog | grep demo.api
Dec 28 22:54:19 platop api[13012]: demo.api.INFO: Message received: {"jsonrpc":"2.0","id":1,"method":"devices/listAll"} [] []
Dec 28 22:54:19 platop api[13012]: demo.api.INFO: Sending reply: {"jsonrpc":"2.0","id":1,"result":[{"id":0,"name":"Philipp PC","type":"pc"}]} [] []
```
Example 5: Adding CLI-support with 'root'-only access
-----------------------------------------------------
Trying to access the API via the CLI as non-root user:
```bash
$ echo '{"jsonrpc":"2.0","id":1,"method":"devices/listAll"}' | php web/example5/api.php; echo
{"jsonrpc":"2.0","id":1,"error":{"code":-32652,"message":"Invalid auth."}}
```
Access API via CLI as root user:
```bash
$ echo '{"jsonrpc":"2.0","id":1,"method":"devices/listAll"}' | sudo php web/example5/api.php; echo
{"jsonrpc":"2.0","id":1,"result":[{"id":0,"name":"Philipp PC","type":"pc"}]}
```
Example 6: Using the API with JavaScript and cookie-based auth
--------------------------------------------------------------
This example shows how to use JS with cookie-based authentication. With the JS `Client` class, calling the API is very simple:
```javascript
var api = new Datto.API.Client('/example6/api.php');
var params = {};
api.call('devices/listAll', params, function (devices) {
// Success function
}, function (result) {
// Failure function
});
```