interaxiom/php-api

Interaxiom API的包装器

v1.0.0 2024-02-22 05:09 UTC

This package is auto-updated.

Last update: 2024-09-28 19:04:19 UTC


README

PHP Wrapper for Interaxiom APIs

这个PHP包是一个轻量级的Interaxiom API包装器。这是在PHP应用程序中使用interaxiom.com.au API的最简单方法。

<?php

/**
 * # Visit https://myaccount.interaxiom.com.au/#!user/api
 * to get your credentials
 */
 
require __DIR__ . '/vendor/autoload.php';
use \Interaxiom\Api;

$api = new Api(
    $public_key,
    $private_key,
    $application_key,
    $endpoint
);
echo "Welcome " . $api->get('/me')['response']['firstname'];

?>

快速入门

要下载此包装器并将其集成到您的PHP应用程序中,您可以使用Composer

以下命令快速集成

composer require interaxiom/php-api

或者,在您的composer.json文件中添加此存储库,或者如果您还没有这个文件,可以在项目的根目录中创建它,内容如下

{
    "name": "Example Application",
    "description": "This is an example of Interaxiom APIs wrapper usage",
    "require": {
        "interaxiom/php-api": "dev-master"
    }
}

Interaxiom 示例

您想使用Interaxiom API吗?也许您想要的脚本已经在这个存储库的示例部分中编写好了!

如何打印API错误详情?

在内部,php-api默认使用GuzzlePHP 6来发送API请求。如果一切顺利,它将直接返回如上例所示的响应。如果出现错误,如缺少端点或对象(404)、认证或授权错误(401或403)或参数错误,Guzzle将抛出GuzzleHttp\Exception\ClientException异常。对于服务器端错误(5xx),它将抛出GuzzleHttp\Exception\ServerException异常。

您可以使用以下代码获取错误详情

<?php

require __DIR__ . '/vendor/autoload.php';
use \Interaxiom\Api;

$api = new Api(
    $public_key,
    $private_key,
    $endpoint,
    $application_key
);

try {
  echo "Welcome " . $api->get('/me')['firstname'];
}
catch (GuzzleHttp\Exception\ClientException $e) {
    $response = $e->getResponse();
    $responseBodyAsString = $response->getBody()->getContents();
    echo $responseBodyAsString;
}

?>

支持的API

以下端点可供公共使用

我的账户

相关链接