Download the PHP package affittocertificato/clientapi without Composer
On this page you can find all versions of the php package affittocertificato/clientapi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download affittocertificato/clientapi
More information about affittocertificato/clientapi
Files in affittocertificato/clientapi
Package clientapi
Short Description Lightweight implementation for services of Affitto Certificato API
License GPL-3.0-or-later
Homepage https://github.com/bradiporitmico/affittocertificato_clientapi
Informations about the package clientapi
Affitto Certificato Client API Library
Simple and fast implementation for Affitto Certificato web service API
Basic example
Response structure
API calls always return a structured response, as in the example below:
-
"success" (boolean) means that the call has been succesfully processed, this not means "success" of the operations itself, but only mean "succesfull" of the api call. Anyway if the "success" is true you can be sure that the response is valid and all data you need is there.
-
"requestID" is an universal id that identify the request for future logging and debugging operations
-
"errorType" is a unique string that identify the type of error. This field is useful, to the client, to discriminate the type of error and adopt the appropriate measures (display an error message, rollback on the database, and so...)
-
"errorMessage" is a descriptive text of error (if any)
- "response" is the "real" response produced by API method, and the structure depend on it. In the example above is shown the response for "userRatingByEmail" call. To test and see al the different response structures, you can visit this page and try the call by yourself
Requirements
- PHP >= 7.0
Installation
The recommended way is to install the lib through Composer.
Simply run composer require affittocertificato/clientapi
for it to be automatically installed and included in your composer.json
.
Now you can use the autoloader, and you will have access to the library:
Documentation
A swagger testing page can be found here. You can use this page to test the API calls.
License
This library is released under the GPL-3.0 license