codesmen/yourmembership-lumen-api

YourMembership.com 为 Lumen (Laravel) 的 PHP API

此包的规范仓库似乎已不存在,因此包已被冻结。

dev-master 2019-10-26 15:38 UTC

This package is not auto-updated.

Last update: 2024-01-01 03:48:08 UTC


README

此包处于开发中,它基于YM-API的代码。

此包实现了PHP包装器,用于与http://www.yourmembership.com/company/api-reference/

Laravel 安装(5.2+)

使用composer通过在您的composer文件中添加以下内容来要求此包

"require": {
    "codesmen/yourmembership-lumen-api": "^0.0.1"
},

然后运行 composer update 下载包。

或者使用

composer require codesmen/yourmembership-lumen-api

更新composer后,将服务提供者添加到config/app.php文件中的providers数组中

Codesmen\YourMembershipLumenAPI\YourMembershipServiceProvider::class,

发布包的配置

php artisan vendor:publish --provider="Codesmen\YourMembershipLumenAPI\YourMembershipServiceProvider"

config/yourmembership-lumen-api.php中填写您的API_KEYSECRET_API_KEYSA_PASSCODE

使用方法

<?php
...
use Codesmen\YourMembershipLumenAPI\YMLA;

class YourController extends Controller {

    public function index(YMLA $ymla)
    {
        // Array results
        $result = $ymla->call('Auth.Authenticate', [
            'Username' => 'email@examle.com',
            'Password' => 'password',
        ])->toArray();
        
        // JSON/Object result
        $result = $ymla->call('Auth.Authenticate', [
            'Username' => 'email@examle.com',
            'Password' => 'password',
        ])->toJson();
        
        // XML result
        $result = $ymla->call('Auth.Authenticate', [
            'Username' => 'email@examle.com',
            'Password' => 'password',
        ])->toXML();
    }
    ...
}

关于YourMembership会话的说明

您不需要生成会话进行认证,因为这个包会为您完成。会话ID保存到Lumen\Laravel缓存中,有效期为15分钟。

从YourMembership返回原始XML结果

这将返回XML格式的结果,并将返回头设置为XML,以便浏览器正确打印有效的XML。

...
$result = $ymla->call('Auth.Authenticate', [
    'Username' => 'email@examle.com',
    'Password' => 'password',
])->toXML();

return response()->xml($result);
...