接入指南 #

1、接入流程 #

流程简介

注册、登录厦航开放平台，并进行个人、企业开发者认证
创建应用，获取apikey
设置测试环境的IP白名单，以便接入厦航测试环境
申请服务能力，获取服务能力下的API权限
测试环境调用API进行测试
测试通过后，申请接入生产环境，提供生产环境IP白名单
进行生产环境联调测试
正式上线

注意事项

白名单的开通一般需要2-3个工作日，请根据具体情况来安排
对接厦航ndc接口进行测试时，请预定远期的、避开节假日的航班，并且当天出票要在当天退票

2、入驻成为开发者 #

2-1 注册登录 #

要使用开放平台的任何设施首先要成为开放平台开发者。
打开厦航开放平台首页，进行注册。

注册注意事项：
- 用户名保证字母开头，长度6-10位，只包含字母、数字、下划线。
- 密码足够复杂。
- 真实使用的手机号与邮箱。
- 认真阅读厦门航空责任声明与隐私通知。
打开开放平台首页，使用注册的账号密码登录。

2-2 个人开发者认证 #

左侧菜单栏选择 “个人中心”，点击“开发者认证”，选择个人开发者认证。

提交个人开发者认证信息，并等待审批。

个人开发者认证注意事项：
- 填写真实的证件号码。
- 上传图片符合条件。
- 使用场景字数不少于100。
- 仔细阅读厦门航空开放平台开发者认证协议。

2-3 企业开发者认证 #

左侧菜单栏选择 “个人中心”，点击 “开发者认证”，选择企业开发者认证。

提交企业开发者认证信息，并等待审批。

企业开发者认证注意事项：
- 填写真实企业名称，申请人姓名，证件号。
- 上传图片符合条件。
- 使用场景字数不少于100。
- 仔细阅读厦门航空开放平台开发者认证协议。

3、应用管理 #

3-1 创建应用 #

登录开放平台后，点击首页的“我的应用”进入应用管理页面。

在“我的应用”界面，点击“新建”创建一个新的应用

在弹出的对话框中，填入应用信息，点击“确定”创建成功。（注：应用一旦创建，信息无法修改！）

3-2 应用配置 #

点击左侧菜单栏 “我的应用”，进入应用管理页面，选择需要查看的应用，点击应用一栏右侧 “配置”，进入应用配置页面，该页面可以查看当前应用的详细信息、apikey、拥有的服务能力列表、拥有的API列表，以及应用的报警联系人。

apikey列表项，包含测试、生产环境的apikey、环境状态以及环境IP白名单，测试环境的apikey在配置了测试环境IP白名单之后生成，生产环境的apikey在接入生产环境之后生成。
- 点击apikey右侧的 “重置”，可以重新生成apikey；
- 点击IP白名单右侧的 “修改白名单” 可以对该环境的IP白名单进行修改（注：需管理员审核）；
- 如果还未接入生产环境，可以点击生产环境一栏右侧的 “申请环境“ 申请接入生产环境
服务能力列表项，包含已拥有的服务能力名称，以及当前服务能力的可用状态
- 点击 “获取更多服务能力” 可以对未拥有的服务能力进行申请
API列表项，包含已拥有的API名称、应用在测试和生产环境中该API的可用状态以及并发量配额（API接口的每秒事务数）
- 点击API名称，可直接跳转API介绍文档；
- 点击相应环境的 “申请配额”，可以对指定API的指定环境申请提升API的配额。

3-3 订阅报警 #

进入 “我的应用” 界面，选择想要订阅报警的应用，点击右侧 “订阅报警”，在弹出的窗口中填入报警人的信息，选择报警方式并填入与报警方式对应的联系方式。

4、服务能力申请 #

点击左侧菜单栏“服务能力列表”，可以查看当前开放的服务能力列表，点击可查看服务能力详细介绍。服务能力详情页有该服务能力会用到的API列表，点击API，可以查看该API的详细文档。点击右上角“立即获取”可以申请服务能力。同时，也可以通过 “我的应用”，在列表中点击需要申请服务能力的应用一栏右侧的 “配置”进入应用配置页面，点击“获取更多服务能力”进入服务能力的申请页面。

选择了某个应用后，可以看到当前已启用的服务能力，以及未启用并且可以申请的服务能力，选择需要的服务能力，并填入申请理由，点击“提交”完成申请，等待管理员审核。

申请完服务能力之后，可以点击左侧菜单栏的 “申请记录” 下的 “服务能力申请记录” 查看服务能力的历史申请记录、申请的状态以及反馈信息。

5、环境接入 #

5-1 环境接入 #

环境接入主要是对生产环境的接入申请，测试环境默认已经接入，点击左侧菜单栏“我的应用”，选择需要申请的应用，点击列表栏右侧“配置”，进入应用的配置页面，点击生产环境一栏右侧的“申请环境”，填入IP白名单以及申请理由，然后提交，等待管理员审核。

提交了环境接入申请后，可以点击左侧菜单栏的 “申请记录” 下的 “环境接入申请记录” 选择申请类型为 ”环境接入申请“ 查看环境接入的历史记录、申请的状态以及反馈信息。

5-2 IP白名单设置 #

IP白名单设置包括测试、生产环境的IP白名单修改，点击已接入环境一栏右侧的“修改白名单”，在弹出的对话框中输入修改后的IP白名单以及申请理由，提交，等待管理员审核。

提交了IP白名单修改申请后，可以点击左侧菜单栏的 “申请记录” 下的 “环境接入申请记录” 选择申请类型为 “修改白名单” 查看IP白名单的历史修改记录、申请的状态以及反馈信息。

6、API管理 #

点击左侧菜单栏“我的API”，在应用及环境一栏选择想要查看API的应用以及对应的环境，点击“查询”即可获取相应的API列表，可以查看各API的当前五分钟内的并发峰值以及并发量上限，此外，可以查看API的运营指标、申请提升API配额（API接口的每秒事务数）、在线API沙盒调用、查看API详细文档。

6-1 查看API运营指标 #

点击API一栏右侧的“运营指标”，可以查询当前API的某个时间段的API请求量。

6-2 API配额申请 #

通过查看API的运营指标，可以知道各个时间段该API的请求量，判断是否需要提升配额，点击API一栏右侧的 “配额申请”，在弹出的对话框中填入所需配额（API接口的每秒事务数）、申请理由后提交申请，等待管理员审核。

提交了API配额申请后，可以点击左侧菜单栏的 “申请记录” 下的 “API配额申请记录”，查看API配额的历史申请记录、申请的状态以及反馈信息。

6-3 在线沙盒调用 #

选择想要进行沙盒调用的API，点击右侧“在线沙盒调用”，会跳转当前API的Swagger页面，可以查看该API的请求范例，点击 “Try it out” 按钮，填入请求参数和apikey，点击 “Execute” 发送请求，获取响应。（注：沙盒调用API需先设置测试环境的IP白名单；apikey在 “我的应用” - “配置” 中查看，有测试、生产两个apikey）

6-4 API文档查看 #

点击API一栏右侧的 “API详情文档”，可以跳转API文档页，查看API的详细文档。

6-5 代码调用 #

点击API名称后的 “详情”，可以获取该API的真实请求地址。请求时，在配置好请求参数后，需要在HTTPHeader中添加apikey参数，填入应用对应环境的apikey。