summaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..f3fc3b7
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,37 @@
+# guzzle-cardmarket-api-middleware
+
+to use with the [Cardmarket API](https://api.cardmarket.com/ws/documentation)
+
+## Installation
+```
+composer require drogueronin/guzzle-cardmarket-api-middleware
+```
+
+## How to use
+
+```php
+use GuzzleHttp\Client;
+use GuzzleHttp\HandlerStack;
+use CardmarketApi\OAuthMiddleware;
+
+// Create default HandlerStack
+$stack = HandlerStack::create();
+
+// Add this middleware to the top with `push`
+$stack->push(new OAuthMiddleware(), 'oauth');
+
+// Initialize the client with the handler option and cardmarket oauth data
+$client = new Client([
+ 'handler' => $stack,
+ 'base_uri' => 'https://api.cardmarket.com/ws/v2.0/output.json/',
+ 'cardmarket' => [
+ 'app_token' => 'your_app_token',
+ 'app_secret' => 'your_app_secret',
+ 'access_token' => 'your_access_token',
+ 'access_token_secret' => 'your_access_token_secret',
+ ],
+]);
+
+// Request a resource
+$response = $client->get('account');
+```