heshanh/gofax

GoFax API

v0.1-alpha 2018-01-29 06:32 UTC

This package is not auto-updated.

Last update: 2024-09-28 19:47:31 UTC


README

此SDK提供对GoFax SOAP API的简单访问。它目前处理以下请求:

  • 列出SOAP函数
  • 获取接收到的传真列表
  • 获取特定传真的传真数据

内容

入门指南

使用Composer将SDK安装到您的项目中。

composer require heshanh/gofax

与Laravel集成

此包包含一个针对Laravel的特定服务提供程序,允许您从配置文件和环境设置中设置凭证。

注册提供程序

将以下内容添加到您的 config/app.php 文件中的 providers 数组。

heshanh\GoFax\LaravelServiceProvider::class

添加配置键

在您的 config/services.php 文件中,将以下内容添加到数组。

'gofax'=> [
        'api_url' => env('FAX_API_URL'),
        'api_key' => env('FAX_API_KEY'),

    ]

添加环境键

在您的 .env 文件中,添加以下键。

FAX_API_KEY=
FAX_API_URL=

解析客户端

要解析客户端,您只需从服务容器中获取它。这可以通过几种方式完成。

依赖注入

use heshanh\GoFax;

public function yourControllerMethod(SoapClient $client) {
    // Call methods on $client
}

使用 app() 辅助函数

use heshanh\GoFax;

public function anyMethod() {
    $client = app(SoapClient::class);
    // Call methods on $client
}

可用方法

$client->getFunctions()

$client->getReceivedFaxes()

$client->getFaxDataFromId($faxId)

有关更多信息,请参阅GoFax API文档 https://www.gofax.com.au/fax-api/

测试

即将推出