开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
开发文档(v3版) 
规则说明
密钥与签名
应用开发配置
常见问题
接口规则 >  > 基本原则
收藏
订阅更新
我的文档
设置
基本信息
支付宝 api v3 遵循 restful 设计规范,使用面向资源的 url、标准 http 响应码、http 方法和身份验证。
支付宝 api v3 支持行业通用的 ,请求和响应参数支持 json schema 规范,开发者可使用开源生态工具进行开发及调试。
接入点
正式环境:https://openapi.alipay.com
沙箱环境:https://openapi-sandbox.dl.alipaydev.com
身份认证
支付宝 api v3 通过数字签名方式对调用方进行身份验证。请求发起阶段,开发者需要使用应用私钥对请求内容进行签名,支付宝会使用应用公钥验证请求签名,以确保请求由开发者发出;同样的,在响应阶段,支付宝会使用支付宝私钥对响应结果进行签名,开发者需要使用支付宝公钥验证签名,以确保响应由支付宝发出。
身份信息需要通过请求的请求头 authorization 字段传递,对应值可以参考
应用私钥代表应用身份,请确保私钥的安全,不要在 github、客户端代码等公共可访问区域共享应用私钥。
所有的 api 请求必须使用 https,不应忽略服务器证书验证的错误,避免被恶意劫持。
请求规范
基本信息
支付宝 api v3 协议使用 restful 风格请求,接口请求需要使用对应的 http 方法,具体请参考业务接口文档。
动词覆盖说明:对于部分代理场景,不支持 put、patch、delete 等操作,可以使用 post 发送请求,同时携带 http header x-http-method-override 来传输实际需要使用的 http method。
数据格式
支付宝 api v3 使用 作为消息体的数据交换格式。请求须设置 http 头部:
content-type: application/json
accept: application/json
加密请求和文件上传 api 除外。
api 应答中的数据有可能包含商家传入的数据,即可能是未经检查的用户输入内容。为了避免 xss(cross-site scripting)攻击,请调用方在使用应答数据前根据场景做适当的转义或者过滤。
请求的唯一标识
在支付宝 api v3 协议中,每次请求需要有唯一请求标识。当需排查问题时,可以像凯发app官方网站的技术支持提供请求的唯一标识,以便我们更快的定位到具体的请求。
商家发起请求时,可以传递请求唯一标识,请求的唯一标识包含在请求的 http 头 alipay-request-id 中,允许包含 a-za-z0-9-_ 字符,长度限制 32 位。
支付宝返回响应时,会对请求分配唯一请求标识,请求的唯一标识包含在响应的 http 头 alipay-trace-id 中,包含 a-za-z0-9-_ 字符,长度不超过 32 位。


字符集
支付宝 api v3 使用 仅支持 utf-8 字符集,请求可以在 content-type 中显示指定使用 utf-8,未指定则默认未 utf-8 编码。
文件上传
支付宝 api v3 支持文件上传功能,在使用文件上传接口时,http 请求需要使用 multipart/form-data 格式,具体可参考 规范。传输文件时,http 请求 body 会分为多个 part,其中业务参数需要通过 data 字段传递,其格式为 json,content-type 使用 application/json,其他 part为文件内容,content-type 应为具体的文件格式。
文件上传示例如下:
错误处理
支付宝 api v3 使用 http 状态码来表示请求处理的结果。
业务请求处理成功,支付宝将返回 200。
页面重定向接口,例如 ,请求处理成功,支付宝返回 302 跳转到用户支付页面。
业务处理失败,支付宝将会返回4xx范围内的错误码,一般为请求鉴权失败、缺少必要的入参等业务异常。
支付宝内部的服务系统错误,将返回 500/502 的状态码,对该类错误,商家需要重试。
错误码和错误提示
当请求处理失败时,支付宝会在消息体返回更多错误描述内容。
code:详细错误码,参考接口描述及公共错误码,商家需要对该错误码处理。
message:错误描述,具体错误原因的文字描述,开发者可参考该描述判断错误原因。
错误示例
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图