跳转至

调用约定

iPaaS 平台对外主要提供 gRPC 接口,首先请参考 gRPC Supported Languages 安装好对应语言的 gRPC 客户端模块。

鉴权

iPaaS 平台采用 Baerer Token 进行鉴权,将 Token 放入 gRPC 请求 metadata 的 Authorization 字段中即可。

const metadata = new Metadata()
metadata.add('Authorization', `Bearer ${token}`)

异步任务

一般来说,如果你请求的接口包含 client_task_token 字段,这个接口便是一个发起任务的接口。

iPaaS 服务设计为幂等,在发起任务时,客户端可以提供一个客户端令牌以确保请求的幂等性。如果客户端没有提供客户端令牌,服务将生成一个随机令牌以确保幂等性。

通过 TaskService ,调用方可以使用客户端提供的 client_task_token 或是响应中的 task_id 来换取任务执行结果。

具体请参考任务服务接口介绍

跨数据中心网关

通常情况下,开放接口都需要通过跨数据中心网关来访问。大部分接口都需要传入 datacenter 字段,以判断其请求归属于哪个数据中心。此外, instance_id 是跨数据中心唯一的,因此,在大部分情况下,如果传入 instance_id ,则不需要再传入 datacenter 字段。