README

Simple and fast implementation for Affitto Certificato web service API

Basic example

$client = new \AffittoCertificato\Api\Client();

if (!$client->login('username','password')){
  throw new Exception ("Unable to login");
}

// get ratings using user's email address
if (!$client->userRatingByEmail('test@mail.com')){
  throw new Exception ("Unable to get ratings");
}

// to get api results use method getResponse() which return an object as described later in ## responses section
$result = $client->getResponse();
if (!$result->success){
  throw new Exception ("Request failed");
}

Response structure

API calls always return a structured response, as in the example below:

{
    "success": true,
    "requestID": "4e7b02eb-c17e-4046-9449-caca246d5bb8",
    "errorType": null,
    "errorMessage": null,
    "response": {
        "registered": false,
        "referenced": false,
        "probed": false
    }
}

"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:

require 'vendor/autoload.php';

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

affittocertificato / clientapi

Maintainers

Details