在途商旅
  1. API调用指南
在途商旅
  • 关于本文档
  • API调用指南
    • API列表
    • 接入流程
    • 接口通用说明
    • 通用错误码
  • 服务端接口
    • 一、鉴权管理
      • 1、接口鉴权
        • a、获取token
      • 2、单点登录
        • a、目标页概述
        • b、单点登录
    • 二、企业信息
      • 1、概述
      • 2、组织单位
        • a、概述
        • b、常见问题
        • c、场景说明
        • d、组织同步
        • f、负责人同步
      • 3、员工信息
        • 概述
        • 场景说明
        • 常见问题
        • 手机号国家编码表
        • 员工同步
        • 员工直属主管同步
        • 员工常住地同步
        • 获取职级列表
        • 获取证件类型
        • 员工信息查询
      • 4、成本中心
        • 概述
        • 常见问题
        • 场景说明
        • 成本中心(部门所属)
        • 成本中心(员工所属)
      • 5、项目
        • 概述
        • 常见问题
        • 场景说明
        • 项目同步
      • 6、法人
        • 概述
        • 常见问题
        • 法人同步
    • 三、业务数据
      • 1.出行前
        • 概述
        • 差旅申请
          • 申请单同步
          • 申请单变更前校验
          • 取消申请单提前验证
          • 申请单状态变更
          • 获取申请单
          • 获取申请单使用状态
          • 获取申请单出行概况
          • 获取差旅类型
          • 获取费用类型
      • 2.出行中
        • 订单
          • 客票状态
          • 订单查询(全量)
          • 订单查询(分页)
          • 订单确认-V1
          • 订单确认-V2
      • 3.出行后
        • 账单
          • 获取账单主信息
          • 分页获取账单主信息
          • 获取账单订单明细
          • 账单中疑异订单通知
          • 确认账单通知
        • 票据
          • 订单开票信息
          • 个付电子发票查询
          • OCR票据查询
          • 订单数电票
      • 4.工作流
        • 查询审批记录
        • 审批结束通知
        • 审批记录同步
    • 四、事件订阅
      • 1、概述
      • 2、事件列表
      • 3、数据推送
      • 4、示例代码
      • 5、需求单服务类型
      • 8、openapi-sdk
      • 6、事件订阅接口
        • a、订阅事件
        • b、删除订阅
        • c、查询订阅
    • 五、通用数据
      • 国家编码对照表
      • 获取城市列表(废弃)
      • 获取城市列表V2
    • 六、其他
      • 补贴查询
      • 自定义补贴场景明细同步
  1. API调用指南

API列表

概述#

服务端 API 可帮助你新增、修改、获取在途系统中的数据。关于如何调用服务端 API,可查看文档:调用流程

列表#

鉴权管理#

API名称
请求方式请求地址
说明
获取/刷新access_tokenPOST/bin/token根据密钥获取 access_token,有效期目前为30分钟,需定时刷新,建议在 access_token 剩余有效期小于5分钟时重新获取 access_token
单点登录POST/tmc/v1/sso-url此接口用于获取指定编号员工登录到在途系统的自动登录链接。浏览器访问该链接将能自动免密登录到在途系统。

企业信息#

API名称
请求方式请求地址说明
组织单位POST/tmc/v1/org/sync组织编码作为组织的唯一标识。组织单位编码(code)不存在,做新增操作,若存在则做更新操作。
员工同步POST/tmc/v1/user/sync员工号作为员工的唯一标识,员工号不存在,做新增操作,若存在则做更新操作。
获取职级列表GET/tmc/v1/user/level-list获取在途系统中员工职级列表
获取证件类型GET/tmc/v1/user/cert-type接口用于获取在途系统中定义的证件类型数据。
上级审批人同步POST/tmc/v1/user/relation/sync同步员工的直接汇报人信息到商旅系统,在员工信息中体现。
用户角色同步POST/tmc/v1/user/role/sync同步更新员工的角色信息到商旅系统。
成本中心同步POST/tmc/v1/cost-center/sync成本中心是对成本和费用承担控制、考核责任的中心;成本中心编码及成本中心所属组织编码组成联合主键,企业内应保证唯一。
项目数据同步POST/tmc/v1/project/sync同步项目信息至在途系统中,接口通过项目代码(code)来作为项目的唯一标识
法人信息同步POST/tmc/v1/corp/sync同步企业的法人信息至在途系统中,接口通过社会信用代码或自定义编码作为为题标识,企业内保证唯一。

业务数据#

API名称
请求方式请求地址说明
出行前
差旅申请同步POST/tmc/v1/travel-plan/save外部OA系统推送差旅申请单给在途系统,提交的差旅申请单如果不指定状态则默认设置为[有效]。对于编号相同的差旅申请单将作修改操作
修改申请单状态POST/v1/travel-plan/status根据差旅计划单号,修改差旅申请单的状态。
获取出差申请单使用状态GET/tmc/v1/travel-plan/applyStatus根据差旅计划单号查询差旅申请单是否已预定业务订单
获取差旅申请单GET/tmc/v1/travel-plan/list根据差旅单编码或者时间范围来获取在途系统中的出差申请单数据列表。
获取差旅类型GET/tmc/v1/travel-plan/travel-type获取企业在在途系统中配置的差旅类型数据。(eg:售前支持、培训)
获取费用类型GET/tmc/v1/travel-plan/expense-list获取企业在在途系统中配置的差旅申请中可用的费用类型(eg:交通费、住宿费)
出行中
订单查询(全量)GET/tmc/v1/order/queryList根据时间范围获取在途系统中业务订单数据列表
订单查询(分页)GET/tmc/v1/order/queryList根据时间范围分页获取在途系统中业务订单数据列表
出行后
账单 - 查询账单主信息GET/tmc/v1/bill/info根据账单code或时间范围查询账单数据列表。
账单 - 账单关联订单明细GET/tmc/v1/bill/order根据账单code分页查询账单中包含的订单数据列表。
账单 - 确认账单通知POST/tmc/v1/bill/confirmInvoiceOA系统确认获取到的账单信息无误后,通知商旅系统确认结果确认账单
账单 - 账单对账结果反馈 POST/tmc/v1/bill/billErrorInfoOA系统核对账单后,通知商旅系统哪些订单有异议

事件订阅#

API名称
请求方式请求地址说明
订阅事件POST/tmc/v1/callback/register注册新的回调事件通知
删除订阅POST/tmc/v1/callback/delete删除已注册的回调事件
查询订阅POST/tmc/v1/callback查询已订阅的回调事件

通用数据#

API名称
请求方式请求地址说明
国家编码对照表GET/tmc/v1/basis/district国家码表
城市列表GET/tmc/v1/basis/district获取在途系统中的标准城市数据列表
上一页
关于本文档
下一页
接入流程
Built with