coolcodemy/yourmembership-laravel-api

YourMembership.com PHP API for Laravel

0.0.1 2017-01-20 04:07 UTC

This package is not auto-updated.

Last update: 2024-09-28 19:42:08 UTC


README

该包处于开发中,它基于以下代码 YM-API.

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

Laravel 安装 (5.2+)

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

"require": {
    "coolcodemy/yourmembership-laravel-api": "^0.0.1"
},

然后运行 composer update 下载包。

或者使用

composer require coolcodemy/yourmembership-laravel-api

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

CoolCodeMY\YourMembershipLaravelAPI\YourMembershipServiceProvider::class,

发布包的配置

php artisan vendor:publish --provider="CoolCodeMY\YourMembershipLaravelAPI\YourMembershipServiceProvider"

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

用法

<?php
...
use CoolCodeMY\YourMembershipLaravelAPI\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 会话说明

由于此包将为您生成会话,因此无需生成用于身份验证的会话。 SessionID 将保存到 Laravel 缓存中,有效期为 15 分钟。

从 YourMembership 返回原始 XML 结果

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

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

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