README

Bluemoon SOAP API的Laravel包装器。

安装

通过Composer

$ composer require primitivesocial/bluemoonsoapwrapper

通过git仓库的composer.json文件

"repositories" : [
  ...,
  {
    "type": "package",
    "package": {
      "name": "primitivesocial/bluemoonsoapwrapper",
      "version": "0.0.1",
      "source": {
        "type" : "git",
        "url" : "git@github.com:PrimitiveSocial/bluemoon-soap-wrapper.git",
        "reference" : "0.0.1"
      },
      "dist": {
        "url": "https://github.com/PrimitiveSocial/bluemoon-soap-wrapper/archive/master.zip",
        "type": "zip"
      }
    }
  }
]

环境变量

BLUEMOON_CLIENT_URL=
BLUEMOON_CLIENT_SECRET=
BLUEMOON_CLIENT_ID=
BLUEMOON_USERNAME=
BLUEMOON_PASSWORD=
BLUEMOON_LICENSE=

BLUEMOON_SOAP_CLIENT_URL=
BLUEMOON_SOAP_USERNAME=
BLUEMOON_SOAP_PASSWORD=
BLUEMOON_SOAP_SERIAL=

BLUEMOON_APPLICATION_URL=
BLUEMOON_LEASE_URL=
BLUEMOON_APPLICATION_API_URL=
BLUEMOON_ESIGNATURE_API_URL=
BLUEMOON_DEBUG=true

您必须添加一个名为bluemoon.php的配置文件。该软件包自带一个适用于所有三个Bluemoon设置的配置文件。

<?php

return [
	// For use with REST api if you're using that
	'rest' => [
		'url' => env('BLUEMOON_CLIENT_URL'),
		'secret' => env('BLUEMOON_CLIENT_SECRET'),
		'id' => env('BLUEMOON_CLIENT_ID'),
		'username' => env('BLUEMOON_USERNAME'),
		'password' => env('BLUEMOON_PASSWORD'),
		'license' => env('BLUEMOON_LICENSE'),
	],
	// For user with SOAP api, so you need this
	'soap' => [
		'url' => env('BLUEMOON_SOAP_CLIENT_URL'),
		'username' => env('BLUEMOON_SOAP_USERNAME'),
		'password' => env('BLUEMOON_SOAP_PASSWORD'),
		'serial' => env('BLUEMOON_SOAP_SERIAL'),
	],
	// For use with in browser application
	'application' => [
		'api_url' => env('BLUEMOON_APPLICATION_API_URL'),
		'application_url' => env('BLUEMOON_APPLICATION_URL'),
		'esignature_url' => env('BLUEMOON_ESIGNATURE_API_URL'),
		'lease_url' => env('BLUEMOON_LEASE_URL'),
		'license' => env('BLUEMOON_LICENSE'),
		'debug' => env('BLUEMOON_DEBUG')
	]
];

您也可以通过运行php artisan vendor:publish来安装配置。

使用方法

创建新包装器

创建新包装器的参数：如果未指定，则默认为配置文件。clientSerial：在BlueMoon中的属性序列号。如果您使用多个属性，则很有用。clientUrl：您使用的API URL clientUsername：SOAP API用户名 clientPassword：SOAP API密码

命令

包装器将接受Bluemoon SOAP库中的任何命令，并将返回未解析的数据。

$client = new BlueMoonSoapWrapper();

$result = $this->client->call(
					'lease',
					'GetEsignatureData',
					array(
                		'EsignatureId' => $esignature_id
            		)
			);

有三个必需的参数：method：您正在处理的Bluemoon数据类别的小写名称，例如lease、application、fxn：文档中出现的SOAP函数，例如GetEsignatureData、data：一个数组，包含发送到Bluemoon的所有必需字段