登录接口
1、接口描述
该接口用于36个地区的登录
2、接口地址
POST /v1/login/ext/getCookie HTTP/1.1
3、请求参数
- 参数说明
请求参数为 JSON 格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
aggOrgId | Long | 是 | 企业Id |
示例参数
{
"aggOrgId":123xxxxx
}
4、返回结果
- 返回结果
返回结果为JSON格式。
{
"result":{
"req_id":"c96a5f996a984b1da6ba6a2b1a87dacd",
"success":true,
"time":8072,
"timestamp":1688003227559
},
"value":{
"code":"2000",
"data":{
"tpass":{
"cookie":"DZSWJ_TGC=42cc74250585417bb29be4a9ea91b11e; SSO_LOGIN_TGC=8ab8f13ffa3048f3b17b858be66f6; expire=120; session_expire=1200001688003227306; JSESSIONID=F67B364CB4A8A937B9F00FC1964; token=eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImM1NjRmMDk3MzIwOTQ5NDE5MTg0M2VjMTMyYTAyYjVjIn0.9uR-VFGEoon5awfCdeM56F926w8UsjpLFPGlMBGpM83qGl1vpHvTpjV8h-D6OcfFmFlG4bVLv054tWLCYwKqnw",
"localStorage":{
"naturepublicKey":"0477756744C30F0988A878",
"clientId":"d598efbedd14a36b",
"code":"C25B9EAB0DF84644A7D171",
"areaPrefix":"3100",
"new_key16":"PytdpOQefeB!Xm2y",
"natureuuid":"75b26419eff14106b78a5f63e208a44c",
"userinfo":"JTdCJTIyY5M1X2FiYnJldmlhdGlvbiUyMiUzQSUyMCUyMiU1Q3U1ZjkwJTVDdTZjNDclNUN1NTMzYSU1Q3U3YTBlJTVDdTUyYTElNUN1NWM0MCUyMiUyQyUyMCUyMmxhbmclMjIlM0ElMjAlMjIlMjIlMkMlMjAlMjJyYXJlbHklMjIlM0ElMjAlMjIwJTIyJTJDJTIwJTIyYXJlYU5hbWUlMjIlM0ElMjAlMjIlNUN1NGUwYSU1Q3U2ZDc3JTIyJTdE",
"timestamp":"20230629094700",
"token":"eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImM1NjRmMDk3MzIwOTQ5NDE5MTg0M2VjMTMyYTAyYjVjIn0.9uR-VFGEoon5awfCdeM56F926w8UsjpLFPGlMBGpM83qGl1vpHvTpjV8h-D6OcfFmFlG4bVLv054tWLCYwKqnw"
}
},
"proxyip":"39.xxx.xxx.xxx:xxxx",
"etax":{
"access_token":"eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImM1NjRmMDk3MzIwOTQ5NDE5MTg0M2VjMTMyYTAyYjVjIn0.9uR-VFGEoon5awfCdeM56F926w8UsjpLFPGlMBGpM83qGl1vpHvTpjV8h-D6OcfFmFlG4bVLv054tWLCYwKqnw",
"cookie":"DZSWJ_TGC=42cc74250585417bb29be4a9ea91b11e; SSO_LOGIN_TGC=8ab8f13ffa3048f3b17b858be66f6; expire=120; session_expire=1200001688003227306; JSESSIONID=F67B364CB4A8A937B9F00FC1964",
"localStorage":""
}
},
"success":true,
"message":"登录成功"
}
}
失败返回结果示例
{
"result":{
"req_id":"b58c2ab8200c4e77b3fbe6f9d32fc3af",
"success":true,
"time":95,
"timestamp":1682412374790
},
"value":{
"code":"4006",
"data":"",
"success":true,
"message":"登录方式不正确!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:登录成功;4xxx;登录信息有误;8xxx短信发送频繁;5xxx:系统错误 |
proxyip | 登录成功绑定的代理ip |
etax | 登录税局的信息 |
tpass | 登录登录账户中心信息 |
登录电票平台接口
1、接口描述
该接口用于36个地区的电票平台登录
2、接口地址
POST /v1/login/ext/getDpptCookie HTTP/1.1
3、请求参数
- 参数说明
请求参数为 JSON 格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
aggOrgId | Long | 是 | 企业Id |
示例参数
{
"aggOrgId":123xxxxx
}
4、返回结果
- 返回结果
返回结果为JSON格式。
{
"result":{
"req_id":"0b0a9ae2547842479db60bdbde57538c",
"success":true,
"time":20712,
"timestamp":1684913988957
},
"value":{
"code":"2000",
"data":{
"tpass":{
"cookie":"SERVEa67ea5b2",
"localStorage":{
"naturepublicKey":"03FB250D28C",
"clientId":"fc75f6b881b8f9953035b6f",
"code":"7AA8A7EBC85FC3BEDA7B445",
"areaPrefix":"5100",
"new_key16":"bPGJcDOWyoXU",
"natureuuid":"13c2910ab2de911cab17",
"userinfo":"JTdCJTUyMCUyMmFyZWFOYW1lJTIyJTNBJTIwJTIyJTVDdTVlN2YlNUN1NGUxYyUyMiU3RA==",
"timestamp":"20230524153543",
"token":"eyJhbGciOiJIUzUxMiJ"
}
},
"proxyip":"xx.xxx.xxx.xxx:xxxx",
"etax":{
"access_token":"1g",
"cookie":"SERVEa67ea5b2",
"localStorage":""
},
"dppt":{
"cookie":"SERVEa67ea5b2; "
}
},
"success":true
}
}
失败返回结果示例
{
"result":{
"req_id":"b58c2ab8200c4e77b3fbe6f9d32fc3af",
"success":true,
"time":95,
"timestamp":1682412374790
},
"value":{
"code":"4006",
"data":"",
"success":true,
"message":"登录方式不正确!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:登录成功;4xxx;登录信息有误;8xxx短信发送频繁;5xxx:系统错误 |
proxyip | 登录成功绑定的代理ip |
etax | 登录税局的信息 |
tpass | 登录账户中心信息 |
dppt | 登录发票云平台信息 |
异步登录税局【发送短信验证码】
1、接口描述
该接口用于36个地区税局的新版登录,如果税局登录需要短信验证码登录,则触发短信发送。 注:广东、天津、浙江、湖北不需要短信验证码,该接口可直接登录
2、接口地址
POST /v1/login/ext/etaxcookie HTTP/1.1
3、请求参数
- 参数说明
方式一:用户自主上传登录信息请求参数,JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
nsrsbh | String | 是 | 纳税人识别号 |
encryptionType | integer | 否 | 加密类型 1表示加密,默认0不加密 |
areaCode | String | 是 | 地区编码,比如四川传值为5100或51,青岛为3702 |
gryhm | String | 是 | 用户名,该值可为:居民身份证/手机号/用户名 |
gryhmm | String | 是 | 个人用户密码 ,当encryptionType=1时该值必须加密 |
sflx | String | 是 | 身份类型(FDDBR法定代表人、CWFZR财务负责人、BSY办税员、LPY领票人、QTRY其他人员、FBSR附办税人、PTGLY普通管理员、GPY购票员、SMBS实名办税、FPLYR发票领用人、KPY开票员) |
sjhm | String | 否 | 手机号码,除广东、天津、浙江、湖北外,该值必填 |
方式二:通过aggOrgId登录请求参数,JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
aggOrgId | Long | 是 | 企业id。用户在系统创建企业后获取 |
示例参数
方式一:传参为指定登录信息
{
"nsrsbh":"9151xxxxxxxxxxxxxx",
"areaCode":"5100",
"gryhm":"131xxxxxxxx",
"grymm":"xxxxxx",
"sflx":"BSY",
"sjhm":"131xxxxxxxx"
}
方式二:传参为指定企业aggOrgId
{
"aggOrgId":4683858486xxx
}
加密工具示例:
JSONObject jsonObject=new JSONObject();
jsonObject.put("encryptionType",1);
jsonObject.put("gryhmm",RSAClientUtil.encrypt("yyyyy222!!@@"));
公钥:
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+vuYMGtTU+42wwbaFX+PkCuSeoREKe5V4EJMi553Gc03ficUdpLHIFdEjAMHAxepwm3RAGLwyxYFK/S93k8GYMuV35L2Nj/cVeHS8scsdqXzqLUKaI4wj438OI6HDh7rWsw1M5EgMsoZvQqja53+SgD3mgIy3XyILbmA5jUp2IwIDAQAB
加密方法样例
public static String encrypt(String data) throws Exception {
byte[] bytes = Base64.decode(publicKey);//publicKey 公钥
X509EncodedKeySpec spec = new X509EncodedKeySpec(bytes);
KeyFactory factory = KeyFactory.getInstance("RSA");
PublicKey publicKey = factory.generatePublic(spec);
Cipher cipher = Cipher.getInstance("RSA");
cipher.init(Cipher.ENCRYPT_MODE, publicKey);
int inputLen = data.getBytes().length;
ByteArrayOutputStream out = new ByteArrayOutputStream();
int offset = 0;
byte[] cache;
int i = 0;
while (inputLen - offset > 0) {
if (inputLen - offset > 117) {
cache = cipher.doFinal(data.getBytes(), offset, 117);
} else {
cache = cipher.doFinal(data.getBytes(), offset, inputLen - offset);
}
out.write(cache, 0, cache.length);
i++;
offset = i * 117;
}
byte[] encryptedData = out.toByteArray();
out.close();
return Base64.encode(encryptedData);
}
4、返回结果
- 返回结果
返回结果为JSON格式。
发送短信成功结果示例:
{
"result":{
"req_id":"0f1fe24daa164e95b0191f80a2bf11fc",
"success":true,
"time":4647,
"timestamp":1687241657504
},
"value":{
"code":"2000",
"data":{
"taskId":1671038727830339586
},
"success":true
}
}
登录成功示例:
{
"result":{
"req_id":"76bf6b8d897f4ef5ae6a63b15cb27795",
"success":true,
"time":6331,
"timestamp":1686911276259
},
"value":{
"code":"2000",
"data":{
"dppt":{
"cookie":"DZSWJ_TGC=75c278c9ba32859321ca9; SSO_LOGIN_TGC=ded21069ef41ea848; expire=1800; session_expire=180000016869180; oauth2_referer=etax.sichuan.chinatax.gov.cn; x_host_key=188c3bf28c8-3e90d386f0e13; SSO_SECURITY_CHECK_TOKEN=37727c8eb5; dzfp-ssotoken=287cde5c2d; "
}
},
"success":true,
"message":"税务数字账户登录成功"
}
}
失败返回结果示例
{
"result":{
"req_id":"b58c2ab8200c4e77b3fbe6f9d32fc3af",
"success":true,
"time":95,
"timestamp":1682412374790
},
"value":{
"code":"4000",
"data":"",
"success":true,
"message":"参数nsrsbh不能为空!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:登录成功;4xxx;登录信息有误;8xxx短信发送频繁;5xxx:系统错误 |
data.dppt | 登录数字账户信息 |
data.taskId | 发送短信成功的id,推送短信接口的传参 |
异步登录税局【上传短信验证码登录】
1、接口描述
该接口用于36个地区税局的新版登录上传验证码用于登录的接口。
注:广东、天津、浙江、湖北不需要调用该接口
2、接口地址
POST /v1/login/ext/etaxpushsms HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
nsrsbh | String | 是 | 纳税人识别号 |
taskId | String | 是 | 异步登录税局【发送短信验证码】的返回值 |
smsCode | String | 是 | 短信验证码 |
示例参数
{
"nsrsbh":"9151xxxxxxxxxxxxxx",
"taskId":"123456xxxxx",
"smsCode":"002100"
}
4、返回结果
- 返回结果
返回结果为JSON格式。
登录成功示例:
{
"result":{
"req_id":"76bf6b8d897f4ef5ae6a63b15cb27795",
"success":true,
"time":6331,
"timestamp":1686911276259
},
"value":{
"code":"2000",
"data":{
"dppt":{
"cookie":"DZSWJ_TGC=75c278c9ba32859321ca9; SSO_LOGIN_TGC=ded21069ef41ea848; expire=1800; session_expire=180000016869180; oauth2_referer=etax.sichuan.chinatax.gov.cn; x_host_key=188c3bf28c8-3e90d386f0e13; SSO_SECURITY_CHECK_TOKEN=37727c8eb5; dzfp-ssotoken=287cde5c2d; "
}
},
"success":true,
"message":"税务数字账户登录成功"
}
}
失败返回结果示例
{
"result":{
"req_id":"b58c2ab8200c4e77b3fbe6f9d32fc3af",
"success":true,
"time":95,
"timestamp":1682412374790
},
"value":{
"code":"4000",
"data":"",
"success":true,
"message":"短信验证错误!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:登录成功;4xxx;登录信息有误;8xxx短信发送频繁;5xxx:系统错误 |
data.dppt | 登录数字账户cookie信息 |
校验异步登录税局缓存是否有效
1、接口描述
该接口用于36个地区的异步登录成功后,缓存的税局cookie是否有效
2、接口地址
POST /v1/login/ext/checkAsyncLoginSjCache HTTP/1.1
3、请求参数
- 参数说明
方式一:用户自主上传登录信息请求参数,JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
nsrsbh | String | 是 | 纳税人识别号 |
areaCode | String | 是 | 地区编码,比如四川传值为5100或51,青岛为3702 |
gryhm | String | 是 | 用户名,该值可为:居民身份证/手机号/用户名 |
gryhmm | String | 是 | 个人用户密码 |
sflx | String | 是 | 身份类型(FDDBR法定代表人、CWFZR财务负责人、BSY办税员、LPY领票人、QTRY其他人员、FBSR附办税人、PTGLY普通管理员、GPY购票员、SMBS实名办税、FPLYR发票领用人、KPY开票员) |
sjhm | String | 否 | 手机号码,除广东、天津、浙江、湖北外,该值必填 |
方式二:通过aggOrgId登录请求参数,JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
aggOrgId | Long | 是 | 企业id。用户在系统创建企业后获取 |
示例参数
方式一:传参为指定登录信息
{
"nsrsbh":"9151xxxxxxxxxxxxxx",
"areaCode":"5100",
"gryhm":"131xxxxxxxx",
"grymm":"xxxxxx",
"sflx":"BSY",
"sjhm":"131xxxxxxxx"
}
方式二:传参为指定企业aggOrgId
{
"aggOrgId":4683858486xxx
}
4、返回结果
- 返回结果
返回结果为JSON格式。
{
"result":{
"req_id":"ffb51fa4a1a1450eade74652e1bda1e4",
"success":true,
"time":62,
"timestamp":1687335304149
},
"value":{
"code":"2000",
"data":false,
"success":true,
"message":""
}
}
失败返回结果示例
{
"result":{
"req_id":"8ab99e4757594c95aa17d58f603a75cb",
"success":true,
"time":25,
"timestamp":1687335188139
},
"value":{
"code":"4001",
"success":true,
"message":"企业不存在!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:接口成功;4xxx;登录信息有误;5xxx:系统错误 |
data | true为缓存有效;false缓存失效 |
账号启用
1、接口描述
企业连续登录失败超过10次以上,企业会停用登录功能。如果需要继续使用登录,需要调整登录信息正确后,调用该接口启用登录功能
2、接口地址
POST /v1/login/recoveryLogin HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
aggOrgId | Long | 是 | 企业aggOrgId |
- 示例参数
{
"aggOrgId":369161****80320
}
4、返回结果
- 返回结果
返回结果为JSON格式。
{
"result":{
"req_id":"cea3e572ffe8455b961878863f9ddad8",
"success":true,
"time":29976,
"timestamp":1687833155343
},
"value":{
"code":"2000",
"data":true,
"success":true,
"message":"启用成功"
}
}
失败返回结果示例
{
"result":{
"req_id":"4ba582528ed343e19fbcdc981d4fc4ba",
"success":true,
"time":124,
"timestamp":1687833374984
},
"value":{
"code":"4006",
"data":"",
"success":true,
"message":"企业不存在!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:接口成功;4xxx;登录信息有误;5xxx:系统错误 |
data | true为启用成功 |
税务APP账密登录【发送短信验证码】
1、接口描述
该接口用于税务app登录,登录方式为14,如果税局登录需要短信验证码登录,则触发短信发送。 注:目前支持浙江,四川地区
2、接口地址
POST /v1/login/remote/etaxcookie HTTP/1.1
3、请求参数
参数说明
:通过aggOrgId登录请求参数,JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
aggOrgId | Long | 是 | 企业id。用户在系统创建企业后获取 |
示例参数
传参为指定企业aggOrgId
{
"aggOrgId":4683858486xxx
}
4、返回结果
- 返回结果
返回结果为JSON格式。
发送短信成功结果示例:
{
"result":{
"req_id":"0f1fe24daa164e95b0191f80a2bf11fc",
"success":true,
"time":4647,
"timestamp":1687241657504
},
"value":{
"code":"2000",
"data":{
"taskId":1671038727830339586
},
"success":true
}
}
失败返回结果示例
{
"result":{
"req_id":"b58c2ab8200c4e77b3fbe6f9d32fc3af",
"success":true,
"time":95,
"timestamp":1682412374790
},
"value":{
"code":"4000",
"data":"",
"success":true,
"message":"参数nsrsbh不能为空!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:登录成功;4xxx;登录信息有误;8xxx短信发送频繁;5xxx:系统错误 |
| data.taskId | 发送短信成功的id,推送短信接口的传参 |
税务APP账密登录【上传短信验证码登录】
1、接口描述
该接口用于税务APP账密登录上传验证码用于登录的接口。
注:目前只支持浙江,四川
2、接口地址
POST /v1/login/remote/pushsms HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
taskId | String | 是 | 异步登录税局【发送短信验证码】的返回值 |
smsCode | String | 是 | 短信验证码 |
示例参数
{
"taskId":"123456xxxxx",
"smsCode":"002100"
}
4、返回结果
- 返回结果
返回结果为JSON格式。
登录成功示例:
{
"result":{
"req_id":"76bf6b8d897f4ef5ae6a63b15cb27795",
"success":true,
"time":6331,
"timestamp":1686911276259
},
"value":{
"code":"2000",
"success":true,
"message":"登录成功"
}
}
失败返回结果示例
{
"result":{
"req_id":"b58c2ab8200c4e77b3fbe6f9d32fc3af",
"success":true,
"time":95,
"timestamp":1682412374790
},
"value":{
"code":"4000",
"data":"",
"success":true,
"message":"短信验证错误!"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:登录成功;4xxx;登录信息有误;8xxx短信发送频繁;5xxx:系统错误 |
税务APP快速登录检查
1、接口描述
该接口用于税务APP用于快速登录检查的接口。
注:目前只支持浙江
2、接口地址
POST /v1/login/remote/checkRomoteAppCache HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
参数名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
aggOrgId | Long | 是 | 企业id。用户在系统创建企业后获取 |
示例参数
{
"aggOrgId":123456xxxxx
}
4、返回结果
- 返回结果
返回结果为JSON格式。
登录成功示例:
{
"result": {
"req_id": "989ecf7c078d42bfa8381d55d3974342",
"success": true,
"time": 127,
"timestamp": 1713427104207
},
"value": {
"code": "2000",logn'f
"data": true,
"success": true,
"message": "可以快速登录"
}
}
失败返回结果示例
{
"result": {
"req_id": "989ecf7c078d42bfa8381d55d3974342",
"success": true,
"time": 127,
"timestamp": 1713427104207
},
"value": {
"code": "2000",
"data": false,
"success": true,
"message": "不可以快速登录"
}
}
- 字段说明
字段名 | 说明 |
---|---|
code | 2000:接口成;4xxx;登录信息有误;5xxx:系统错误 |
data | true 可以快速登录,false 不可以快速登录 |