完成接入准备后，服务商可根据本文内容快速在自身系统中集成代用户申请信息功能。

注意：本能力支持代模板申请用户信息，用户测试模板功能等场景。仅需将模板视作普通商家应用授权操作即可。

接入流程

流程简介

服务商需为商家申请用户信息小程序配置主营行业类目，并确认行业类目及使用场景支持申请对应信息，否则无法申请用户信息。可查看下文 第一步：配置应用主营行业。

服务商调用 alipay.open.app.api.query（查询应用可申请的接口出参敏感字段列表）接口，查询该商家应用可申请用户信息的 api_name（敏感信息可申请接口名）、field_name（对应接口出参敏感信息字段）以及 package_code（敏感信息申请能力 code 值）。

调用 alipay.open.app.api.scene.query（查询接口字段使用场景）接口，查询对应场景的 scene_code（场景 code）及 scene_desc（场景 code 描述）。

调用 alipay.open.app.api.field.apply（申请获取接口用户敏感信息字段）接口，提交应用用户信息申请。

获取审核结果：

提交申请后商家可调用 alipay.open.app.api.field.query（用户信息申请记录查询）接口查询对应 app_id 下用户信息申请记录审核状态。

商家还可订阅 alipay.open.app.api.field.changed（用户信息申请记录审核通知）接口，订阅后支付宝将向商家应用网关发送异步通知，反馈商家审核结果通知。详情可查看文末 获取审核结果。

第一步：设置主营行业类目

服务商需要为商家小程序设置主营行业类目，且需确认行业类目及使用场景支持申请所需用户信息，否则支付宝将驳回申请。

申请用户信息对小程序类目有所限制，小程序类目必须符合主营行业对应可申请的会员能力范围，否则会在申请时直接被驳回。

服务商可通过代商家调用接口说明设置商家小程序类目：

调用 alipay.open.mini.baseinfo.query（查询小程序基础信息）接口，查询小程序的类目是否已设置正确。

若小程序没有设置类目或类目不正确，调用 alipay.open.mini.baseinfo.modify（小程序修改基础信息）接口，设置/修改小程序类目。

注意：满足上述条件后仅代表准许申请用户信息不承诺申请一定成功，请以实际申请结果为准。

第二步：查询可申请接口出参敏感字段列表

服务商调用 alipay.open.app.api.query（查询应用可申请的接口出参敏感字段列表）接口，查询该商家应用可申请用户信息的接口（api_name）、对应接口出参敏感信息字段（field_name）以及敏感信息申请能力功能包码（package_code）。

请求示例

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenAppApiApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenAppApiApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenAppApiApi api = new AlipayOpenAppApiApi();
        try {
            AlipayOpenAppApiQueryResponseModel response = api.query();
        } catch (ApiException e) {
            AlipayOpenAppApiQueryDefaultResponse errorObject = (AlipayOpenAppApiQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

响应示例

{
    "code":"unknow-error",
    "message":"系统繁忙"
}

重要响应说明

apis：应用可申请的接口出参敏感字段列表。

api_name：敏感信息可申请接口名。

field_name：敏感信息申请字段。

package_code：敏感信息申请能力 code 值。

第三步：查询接口字段使用场景

商家可调用 alipay.open.app.api.scene.query（查询接口字段使用场景）接口，查询对应场景的 scene_code（场景 code）及 scene_desc（场景 code 描述）。

请求示例

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenAppApiSceneApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenAppApiSceneApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenAppApiSceneApi api = new AlipayOpenAppApiSceneApi();
        String fieldName = "mobile";
        String apiName = "alipay.user.info.share";
        try {
            AlipayOpenAppApiSceneQueryResponseModel response = api.query(fieldName, apiName);
        } catch (ApiException e) {
            AlipayOpenAppApiSceneQueryDefaultResponse errorObject = (AlipayOpenAppApiSceneQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

field_name ：必填，接口出参字段英文名。通过第二步调用 alipay.open.app.api.query 接口获取。

api_name ：必填，接口英文名。通过调用 alipay.open.app.api.query 接口获取。

响应示例

{
    "code":"unknow-error",
    "message":"系统繁忙"
}

重要响应说明

auth_field_scene ：接口信息字段应用场景。

scene_code：场景 code。

scene_desc：场景 code 描述。

第四步：申请用户信息

调用 alipay.open.app.api.field.apply（申请获取接口用户敏感信息字段）接口，为商家的应用申请用户信息。

请求示例

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenAppApiFieldApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenAppApiFieldApiApply {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenAppApiFieldApi api = new AlipayOpenAppApiFieldApi();
        AlipayOpenAppApiFieldApplyModel data = new AlipayOpenAppApiFieldApplyModel();
        AuthFieldApply authFieldApply = new AuthFieldApply();
        authFieldApply.setApiName("alipay.user.info.share");
        authFieldApply.setPackageCode("20201019201538211864");
        authFieldApply.setTinyAppTemplateId("小程序模板id");
        authFieldApply.setSceneCode("6");
        authFieldApply.setCustomerAnswer("有自己的客服团队xx人，能够及时响应并处理舆能力");
        authFieldApply.setFieldName("mobile");
        authFieldApply.setQpsAnswer("预计接口秒级调用量峰值：xx QPS");
        authFieldApply.setMemo("获取xx的用途：（1）xxxx（2）xxxx");
        data.setAuthFieldApply(authFieldApply);
        File picture1 = new File("文件路径");
        File picture2 = new File("文件路径");
        File picture3 = new File("文件路径");
        File picture4 = new File("文件路径");
        File picture5 = new File("文件路径");
        File video = new File("文件路径");
        try {
            Object response = api.apply(data, picture1, picture2, picture3, picture4, picture5, video);
        } catch (ApiException e) {
            AlipayOpenAppApiFieldApplyDefaultResponse errorObject = (AlipayOpenAppApiFieldApplyDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

video、picture_1~picture_5 为应用使用申请用户信息的示例视频/图片，必须包括如何登录、如何授权输出此字段、如何使用等内容。

视频及图片内容至少选择一项上传。

单个图片或视频不超过 10M，最多可上传 5 张图片示例。

api_name：必填，接口英文名。

field_name：必填，申请字段英文名。

package_code：必填，功能包 code。

scene_code：必填，字段使用场景 code。

qps_answer：必填，接入后一年内预计接口秒级调用量峰值。如 预计接口秒级调用量峰值：xx QPS。

customer_answer：必填，是否有自己的客服渠道，能及时响应和处理多少舆情数量。如 有自己的客服团队 xx 人，能够及时响应并处理舆能力。

获取审核结果

用户信息申请记录查询

可调用 alipay.open.app.api.field.query（用户信息申请记录查询）接口查询用户信息申请记录。

请求示例

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenAppApiFieldApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenAppApiFieldApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenAppApiFieldApi api = new AlipayOpenAppApiFieldApi();
        try {
            AlipayOpenAppApiFieldQueryResponseModel response = api.query();
        } catch (ApiException e) {
            AlipayOpenAppApiFieldQueryDefaultResponse errorObject = (AlipayOpenAppApiFieldQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

响应示例

{
    "code":"unknow-error",
    "message":"系统繁忙"
}

重要响应说明

auth_field_response：选填，用户信息申请信息记录查询响应合集。

records：可选，用户信息申请记录表。

user_app_id：可选，用户应用 app_id。

api_name：可选，申请接口英文名。

field_name：可选，申请字段英文名。

status：可选，审核状态。枚举支持：

AUDIT：审核中。

AGREE：通过。

REJECT：驳回。

INVALID：无效（仅服务商代申请场景返回)。

reason：可选，驳回原因。

package_code：可选，接口归属的功能包 code。

更多参数及响应详情查看 alipay.open.app.api.field.query（用户信息申请记录查询）接口文档。

审核消息通知

登录开放平台控制台进入应用详情页，在 开发设置 > 消息服务 > From 平台 页签列表中，订阅 alipay.open.app.api.field.changed（用户信息申请记录审核通知）接口。完成后支付宝将向应用网关发送异步通知，反馈商家审核结果通知。

说明：审核时间通常为 2~3 个工作日，审核通过后可获得该信息字段的权限。

接入指南

接入流程#

流程简介#

第一步：设置主营行业类目#

第二步：查询可申请接口出参敏感字段列表#

请求示例#

响应示例#

第三步：查询接口字段使用场景#

请求示例#

响应示例#

第四步：申请用户信息#

请求示例#

获取审核结果#

用户信息申请记录查询#

请求示例#

响应示例#

审核消息通知#

接入流程

流程简介

第一步：设置主营行业类目

第二步：查询可申请接口出参敏感字段列表

请求示例

响应示例

第三步：查询接口字段使用场景

请求示例

响应示例

第四步：申请用户信息

请求示例

获取审核结果

用户信息申请记录查询

请求示例

响应示例

审核消息通知