nebulosar/php-api

Datattrics API 客户端

2.0.3 2018-04-05 09:42 UTC

This package is auto-updated.

Last update: 2024-09-25 19:03:45 UTC


README

Datatrics

Latest Stable Version Latest Unstable Version Travis branch Scrutinizer Code Quality Code Coverage Code Climate License

Datatrics PHP API 客户端

此包是一个方便的包装器,用于与 Datatrics REST-API 进行通信

安装

客户端的安装有两种方式。首选使用 Composer,但并非总是可行。

Composer

将包包含在您的 composer.json 文件中

{
    "require": {
        "datatrics/php-api": "2.0.x-dev"
    }
}

...然后运行 composer update 并加载 Composer 自动加载器

<?php
require 'vendor/autoload.php';

// ...

手动

获取 Datatrics PHP API 客户端的最新版本

git clone https://github.com/Datatrics/php-api

并在您的项目中包含该类

require_once '/path/to/Client.php';

用法

此客户端可通过很多 API 资源进行访问。您可以通过查看代码来查找它们。它们的名字与文档中的名称相匹配(https://docs.datatrics.com)。

<?php
require 'vendor/autoload.php';

$client = new Client('[api-key]', '[project-id]');

$project = $client->Project->Get('[project-id]');

说明

[api-key] 您收到的或创建的 API 密钥

[project-id] 项目的 id

贡献

我们欢迎贡献,但请注意 API 客户端是由代码生成的。如果您有建议的更改,您仍然可以创建 PR,但您的 PR 不会被合并。然而,我们将调整生成器以反映您的更改。如果您有遗漏的地方,也可以创建 GitHub issue。