Skip to content

Commit a5d35be

Browse files
docs: add code examples
1 parent e5a4a9a commit a5d35be

1 file changed

Lines changed: 41 additions & 8 deletions

File tree

readme.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,67 @@ composer require altravia/openapi
1111
### Instanza della classe
1212

1313
```php
14-
$this->openapi = new \OpenApi\OpenApi($scopes,$user,$apikey,"test");
14+
require_once 'vendor/autoload.php';
15+
16+
$openapi = new \OpenApi\OpenApi($scopes, $user, $apikey, $environment);
1517
```
1618

1719
Dove `$scopes` è un array di stringhe o di oggetti in uno dei seguenti formati:
1820

1921
```php
20-
$scopes=[
22+
$scopes = [
2123
"GET:ws.ufficiopostale.com/comuni",
22-
["domain"=>"ws.ufficiopostale.com", "method"=>"comuni","mode"=>"GET"]
24+
[
25+
"domain"=>"ws.ufficiopostale.com",
26+
"method"=>"comuni",
27+
"mode" =>"GET"
28+
]
2329
];
2430
```
2531

2632
...e `$environment` è l'ambiente sceltro tra `'test'` (default) e `'production'`
2733

34+
OpenApi si occuperá di reperire automaticamente, o generare, un nuovo token quando necessario.
35+
36+
A questo punto, in base agli scopes indicati vengono creati i seguenti oggetti:
2837

29-
A questo punto, in base agli scopes indicati vengono creati i seguenti oggetto:
3038

3139
```php
32-
$this->openapi->ufficiopostale
33-
$this->openapi->imprese
34-
...
40+
// Ogni oggetto verrá creato solo se disponibile nello scope.
41+
$openapi->ufficiopostale
42+
$openapi->comuni
43+
$openapi->imprese
44+
$openapi->visengine
45+
$openapi->marcheTemporali
46+
$openapi->geocoding
47+
$openapi->SMS
48+
$openapi->firmaDigitale
49+
$openapi->pecMassiva
3550
```
36-
3751
che possono essere usati al seguente modo:
3852

3953
```php
4054
$this->openapi->ufficioposale->getCitiesByCap('00132');
4155
```
56+
### Esempi
57+
58+
```php
59+
require_once 'vendor/autoload.php';
60+
61+
// Dichiaro gli scopes necessari
62+
$scopes = [
63+
'GET:comuni.openapi.it/cap',
64+
'GET:imprese.altravia.com/advance',
65+
];
66+
67+
$openapi = new OpenApi\OpenApi($scopes, 'my_username','my_api_key', 'production');
68+
69+
// Prendi informazioni sul cap 00132
70+
$cap = $openapi->comuni->getCitiesByCap('00132');
71+
72+
// Prendi informazioni su una specifica impresa
73+
$impresa = $openapi->imprese->getByPartitaIva('12485671007');
74+
```
4275

4376
# Modulo ufficio postale
4477

0 commit comments

Comments
 (0)