Download the PHP package drteam/uon without Composer
On this page you can find all versions of the php package drteam/uon. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package uon
Short Description U-On Travel RESTful API Client
License MIT
Homepage https://api.u-on.ru/doc
Informations about the package uon
U-On Travel API Client (unofficial)
A simple client that allows to work with API of U-On Travel company.
This library is ready for production usage, all source codes provided "as is".
Requirements
- PHP >= 7.4 (tested on 7.4, 8.0, 8.1, 8.2, 8.3, 8.4 and 8.5)
- ext-curl, ext-json
- guzzlehttp/guzzle ^7.4
How to use
Basic example
See other examples of usage here separated by class names.
All available methods of all classes with descriptions you can find here.
How to configure the client
Object of Config should be added as parameter of client:
But you also can use array of parameters:
If you want to create Client object with default parameters:
Available parameters of configuration
| Parameter | Type | Default | Description |
|---|---|---|---|
| token | string | (required) | Token for work with the system |
| format | string | json |
Response format, json or xml |
| timeout | int | 20 |
Seconds to wait for the server answer |
| tries | int | 2 |
Count of tries if server answers with 429 error code |
| seconds | int | 10 |
Seconds to wait between tries |
| base_uri | string | https://api.u-on.ru |
Base URL of the API |
| user_agent | string | U-On PHP Client v2.x |
User-Agent header sent with each request |
| proxy | string | (none) | Proxy URL passed to Guzzle |
| handler | callable | (none) | Custom Guzzle handler, mainly for testing |
| track_redirects | bool | false |
Track redirects via Guzzle |
| debug | bool | false |
Enable Guzzle debug output |
| verbose | bool | false |
Dump each request endpoint and its parameters |
| verify | bool | (Guzzle default) | SSL verification, set to false to disable it for a broken remote certificate |
Any other parameter name will throw a UonParameterNotAllowedException.
About the page
Some GET methods have a $page parameter (with default state 1),
and you can get only 100 items for one time it $page parameter is exist.
List of endpoints which have a $page parameter.
- /catalog-service/
- /cities/
- /hotels/
- /leads/$date_from/$date_to/
- /leads/$date_from/$date_to/$id_sources/
- /lead-by-client/$id_lead/
- /payment/list/
- /request-action/
- /requests/updated/
- /suppliers/
- /users/
- /user/updated/
These (I mean $page) parameter was added by API developers to reduce
the load on the server. So, do not worry if you see only 100 items in
result messages you just need write loop to get all items from API,
like this:
How to get API token
You need login into your account, then go to the Settings > Integrations > API / WebHooks page, create a key (tick the POST and GET checkboxes) and copy the token code from the API block.
Running tests
The Unit and Feature suites are fully mocked via Guzzle's MockHandler, so
they run offline and do not touch the real U-On API nor require a valid token.
The E2E suite performs read-only calls against the real API. It is skipped
unless a token is provided through the UON_API_TOKEN environment variable:
Static analysis and linting are available too:
How to help to project
If you have a desire, you can help with testing and bugs hunting or make some donation.
Useful links
- U-On Travel - Official website
- U-On Travel API - API documentation
- Basic examples by U-On team of usage written on PHP-Curl library
All versions of uon with dependencies
ext-curl Version *
ext-json Version *
guzzlehttp/guzzle Version ^7.4