alohi/faxplus-api

维护者

详细信息

github.com/alohi/faxplus-php

主页

源代码

问题

安装: 450

依赖: 0

建议者: 0

安全: 0

星标: 24

关注者: 7

分支: 8

开放问题: 2

dev-master 2018-06-10 15:05 UTC

Requires

Requires (Dev)

MIT cffb087089c2a1a1220d6b1048f9a0b739423be2

phpapisdkalohi

This package is not auto-updated.

Last update: 2024-10-02 04:11:27 UTC

README

这是为第三方开发者和组织开发的 FAX.PLUS API v1。为了更好地使用此 API 进行编码，让我们快速浏览一些要点

  • 此 API 假设 /accounts 是入口点，基本 URL 为 https://restapi.fax.plus/v1。
  • 此 API 将请求中发送的所有日期和时间视为 UTC。同样，所有响应中返回的日期和时间都在 UTC
  • 一旦您有了 access_token，您就可以轻松地向资源服务器发送请求，基本 URL 为 https://restapi.fax.plus/v1，以访问您允许的资源。例如，要获取用户的个人资料信息，您需要向 https://restapi.fax.plus/v1/accounts/self 发送请求，当 Authorization 头设置为 "Bearer YOUR_ACCESS_TOKEN" 且自定义头 x-fax-clientid 设置为 YOUR_CLIENT_ID 时

需求

PHP 5.5 及以上

安装与使用

Composer

您只需运行 composer require faxplus/faxplus-api 将 faxplus-api 添加到您的 composer.json 并进行安装（faxplus-api 已发布到 Packagist）。

或者，要通过 Composer 安装绑定，请在 composer.json 或您的本地 composer 配置中添加以下内容

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/alohi/faxplus-php.git"
    }
  ],
  "require": {
    "faxplus/faxplus-api": "*@dev"
  }
}

然后运行 composer install

入门

有一个 示例应用程序，旨在帮助您开始使用此 SDK。按照示例应用程序说明运行您的第一个应用程序。

API 端点文档

所有 URI 都是相对于 https://restapi.fax.plus/v1

模型文档

授权文档

fax_oauth