From e62486dd6a76fc77f062b81c861eb3ee807b1682 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sat, 5 Aug 2017 14:15:59 +0200 Subject: [PATCH] documentation: rewrite the REST API PHP client example Closes https://github.com/shaarli/Shaarli/issues/905 Relates to https://github.com/shaarli/Shaarli/pull/751 See https://shaarli.github.io/api-documentation/ Signed-off-by: VirtualTam --- doc/md/REST-API.md | 57 ++++++++++++++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 20 deletions(-) diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md index f872744e..ad407749 100644 --- a/doc/md/REST-API.md +++ b/doc/md/REST-API.md @@ -68,37 +68,54 @@ $signature = hash_hmac('sha512', $content, $secret); ``` -### Complete example +### Complete examples -#### PHP +### PHP + +This example uses the [PHP cURL](http://php.net/manual/en/book.curl.php) library. ```php + `ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68` +function getInfo($baseUrl, $secret) { + $token = generateToken($secret); + $endpoint = rtrim($baseUrl, '/') . '/api/v1/info'; -```php -$options = [ - 'http' => [ - 'method' => 'GET', - 'jwt' => $token, - ], -]; -$context = stream_context_create($options); -file_get_contents($apiEndpoint, false, $context); + $headers = [ + 'Content-Type: text/plain; charset=UTF-8', + 'Authorization: Bearer ' . $token, + ]; + + $ch = curl_init($endpoint); + curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_AUTOREFERER, 1); + curl_setopt($ch, CURLOPT_FRESH_CONNECT, 1); + + $result = curl_exec($ch); + curl_close($ch); + + return $result; +} + +var_dump(getInfo($baseUrl, $secret)); ``` -- 2.41.0