接口说明
- 查询企业在滴滴企业版管理后台的公司主体档案信息,用于校验、核对滴滴后台的数据
- 接口仅返回正常有效的公司主体信息,自动过滤禁用、过期的无效公司主体数据
基本信息
|
HTTP URL |
/river/LegalEntity/get |
|---|---|
|
HTTP Method |
GET |
|
权限要求 |
|
请求头
|
参数名称 |
参数值 |
|---|---|
|
Content-Type |
application/x-www-form-urlencoded |
请求参数
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
client_id |
应用唯一标识 |
string |
Y |
滴滴开放平台创建应用时,由平台分配的唯一标识,用于识别调用方身份 |
|
access_token |
接口调用授权凭证 |
string |
Y |
授权认证后获取的访问令牌,用于校验接口调用权限;授权认证方式参见【接口认证-授权认证】 |
|
company_id |
租户唯一标识 |
string |
Y |
滴滴企业版租户唯一 ID,代表当前操作的企业主体 |
|
timestamp |
当前时间戳 |
int |
Y |
当前时间戳,精确到秒级 |
|
sign |
签名 |
string |
Y |
根据规则生成的接口签名,用于校验请求合法性与完整性;生成方式参见【接口认证-授权认证】 |
|
keyword |
关键字 |
string |
N |
模糊查询条件,可以使用 out_legal_entity_id(公司主体外部编号)或name(公司主体名称) 查询 |
|
legal_entity_id |
滴滴侧公司主体id |
string |
N |
可使用滴滴侧公司id精准查询 |
|
out_legal_entity_id |
公司主体外部编号 |
string |
N |
可使用公司主体外部编号精准查询 |
|
offset |
数据开始位置 |
int |
Y |
数据分页起始位置,从 0 开始计数,后续查询需为 length 的倍数 |
|
length |
数据条数(最大100条) |
int |
Y |
每页返回数据条数,最大值为 100,超过则按 100 条返回 |
请求示例
curl -X GET -H "Content-Type: application/x-www-form-urlencoded" https://api.es.xiaojukeji.com/river/LegalEntity/get?client_id=client_id_test&access_token=141ea31466478eab2f1c1ddcca2675b989a16552×tamp=1566764837&company_id=12345678980&start_date=2018-05-13&end_date=2018-09-30&offset=0&length=10&sign=091cf244ad5ab16935cfe44fc698bc58
响应参数
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
errno |
错误编码 |
string |
数字 0 表示成功,非0 表示失败 |
|
errmsg |
错误信息 |
string |
errno=0时为常量"SUCCESS",errno!=0时为错误信息 |
|
data |
公司列表 |
object |
|
|
request_id |
接口调用唯一标识 |
string |
用于问题排查、日志追踪,每次调用返回唯一值 |
data数据格式
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
data.total |
总数据条数 |
int |
符合查询条件的有效公司主体总条数,非分页条数 |
|
data.records |
公司列表 |
array |
分页返回的公司主体信息数组,无数据时返回空数组 |
records数组元素格式
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
legal_entity_id |
滴滴侧公司主体id |
string |
|
|
out_legal_entity_id |
公司主体外部编号 |
string |
公司主体业务编码 |
|
name |
公司主体名称 |
string |
|
|
parent_id |
上级公司滴滴侧公司主体id |
long |
|
|
out_parent_id |
上级公司外部编号 |
string |
上级公司主体业务编码 |
|
start_time |
公司主体有效期开始日期 |
string |
|
|
end_time |
公司主体有效期结束日期 |
string |
|
|
taxpayer_no |
纳税人识别号 |
string |
|
|
open_bank |
开户行名称 |
string |
公司登记银行账号开户行 |
|
bank_card_no |
开户行账号 |
string |
公司登记的银行账号 |
|
address |
注册地址 |
string |
工商登记的公司所在地点 |
|
telephone |
注册电话 |
string |
工商登记的公司联系电话 |
响应示例
正常示例
{
"errno":0,
"errmsg":"SUCCESS",
"data":{
"total":1,
"records":[
{
"legal_entity_id":12345678543222245346,
"name":"**有限责任公司",
"out_legal_entity_id":"108",
"parent_id":112689540238402,
"out_parent_id": "1",
"start_time":"2023-01-01 12:00:00",
"end_time":"2026-01-01 12:00:00",
"taxpayer_no":"9653242523MQ46574",
"address":"******",
"telephone":"5653242",
"open_bank":"******",
"bank_card_no":"******"
}
]
}
"request_id":"v7ohF6sWiDwFzJynubgPina3SeNcXFZ2DiS1X8QkdXbo5l+vroIiUrynYOQ4pGHK"
}
异常示例
错误码
版本记录
|
日期 |
更新人 |
更新内容 |
上线时间 |
|---|---|---|---|
|
2023.11.07 |
陈继诗 |
迁移文档 |
|
|
2025.06.18 |
杨露佳 |
新增out_legal_entity_id,out_parent_id |
2025.06.18 |
|
2026.3.27 |
谢朱莉 |
更新文档字段描述 |
|
ES后台页面:
