smsorange/api-library

SMS Orange API 库

v0.1.0 2016-04-06 11:25 UTC

This package is not auto-updated.

Last update: 2024-09-26 00:33:16 UTC


README

Build Status

SMS Orange API 包是一个与框架无关的 PHP 库,旨在简化客户端应用程序与 SMS Orange API 端点之间的通信。

注意

开发中,暂不对外开放使用...

安装

要在您的应用程序中安装 API 包,您需要 composer 和 PHP >= 5.4

如果您尚未安装 composer,请首先按照以下说明操作

https://getcomposer.org.cn/doc/00-intro.md#globally

确认您的 composer 安装后,继续以下说明。

将以下行添加到您的 composer require 数组中

"smsorange/api-library": "dev-master"

或者,如果您在项目中未启动 composer,请创建项目根目录下的 composer.json 文件,并粘贴以下行

{
  "require": {
    "smsorange/api-library": "dev-master"
  }
}

然后,从项目根目录运行以下命令

composer install

API 令牌

为了使用此库,您必须准备好您的 API 令牌。如果您没有,请联系 SmsOrange。

API 参数

        | Select        | select        | cruise-code <br/> webservice   |  `string` <br/> `string`      |
        | GetComponents | getComponents | fare_code* <br/> cruise-code <br/> guests | `string` <br/> `string` <br/> `array` |
        | GetAvailableCategories | getAvailableCategories | cruise-code <br/> cruise-guests | `string` <br/> `array` |
        | GetCabins | getCabins | cruise-code <br/> category-code | `string` <br/> `string` |
        | HoldCabin | holdCabin | cruise-code <br/> cabin_number <br/> dining_preference <br/> first_name <br/> last_name | `string` <br/> `int` <br/> `string` <br/> `string` <br/> `string` |
        | Book | book | cruise-code <br/> guest_data** | `string` <br/> `array` |

** 每个嘉宾的数据数组需要包含以下键

  • 可选

技术文档

您可以在 'docs' 文件夹中找到技术文档。只需在浏览器中运行 index.html。

许可证

MIT ©