meta-tech/pws-client
meta-tech/pws-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
a-sansara 2017-03-14 23:18:39 +01:00
parent b9e3840ebf
commit c569e4d96a
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -36,12 +36,12 @@ use MetaTech\Ws\Client;
$config = Yaml::parse(file_get_contents(__dir__ . '/config/pwsauth.yml'));
$authenticator = new Authenticator($config);
$config = Yaml::parse(file_get_contents(__dir__ . '/config/pwsclient.yml'));
$config = Yaml::parse(file_get_contents(__dir__ . '/config/pwsclient.yml'));
$client = new Client($config, $authenticator);
// on instanciation the client init this calls :
// $client->check();
// $client->call();
// enventually $client->call() (depending on previous response);
// get example
$response = $client->get('/ws/person/222');
@ -55,7 +55,8 @@ if ($response->done) {
// do stuff
}
$client->logout();
// to close and destroy session on serverside :
// $client->logout();
```
@ -89,9 +90,9 @@ uri :
### Server Response
PwsClient intend to receiv any JsonResponse, the structure of the response is free.
However, meta-tech always return this simple Json Structure :
{ done : boolean, msg : 'string contextual msg', data : whatever }
PwsClient intend to receiv any JsonResponse, the structure of the response is free.
However, meta-tech always return this simple Json Structure :
`{ done : boolean, msg : 'string contextual msg', data : whatever }`
### License