README

Affitto Certificato网络服务API的简单快速实现

基本示例

$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");
}

响应结构

API调用始终返回结构化响应，如下例所示

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

"success"（布尔值）表示调用已成功处理，这并不意味着操作的“成功”，而只是表示API调用的“成功”。无论如何，如果“success”为真，则可以确信响应是有效的，所需的所有数据都在其中。
"requestID"是一个通用的ID，用于标识请求，以便进行未来的日志记录和调试操作。
"errorType"是一个唯一的字符串，用于标识错误类型。此字段对客户端很有用，可以区分错误类型并采取适当的措施（显示错误消息、回滚数据库等）。
"errorMessage"是错误（如果有）的描述性文本。
"response"是API方法产生的“真实”响应，其结构取决于它。在上面的示例中显示了“userRatingByEmail”调用的响应。要测试并查看所有不同的响应结构，您可以通过访问此页面并亲自尝试调用。

要求

PHP >= 7.0

安装

建议通过Composer安装库通过Composer。

只需运行composer require affittocertificato/clientapi即可自动安装并包含在您的composer.json中。

现在您可以使用自动加载器，并且您将能够访问库

require 'vendor/autoload.php';

文档

可以在此处找到swagger测试页面。您可以使用此页面测试API调用。

许可协议

此库是在GPL-3.0许可协议下发布的

affittocertificato / clientapi

维护者

详细信息

README

基本示例

响应结构

要求

安装

文档

许可协议