已废弃：老版一键登录接口

本文档仅适用于3.0以前的gysdk 或者 3.0以后仍旧使用ELoginThemeConfig入参的一键登录接口描述。
3.0以后使用完全自定义登录授权页，请统一在《API接口》中查看文档

能力简述

一键认证：一键认证方案，运营商利用其移动数据网络，采用“通信网关取号”及 SIM卡识别等技术，准确验证用户本机号码，实现一键认证，并可有效规避短信验证码泄露风险。 通过运营商网关认证能力，用户无需输入手机号码和短信验证码，即可使用手机号一键认证成功。

使用限制说明：一键认证功能的使用前提是用户打开蜂窝网络，目前支持的网络制式有移动 2G、3G、4G，5G。联通 3G、4G、5G，电信 4G，5G。对于双卡手机，以开启数据流量的 SIM 卡进行认证；对于Wifi环境，在数据网络开通的前提下，会强制使用数据网络触发网关请求，请求仅为几K，可正常校验。 另外，一键认证当前不支持分屏显示，建议此功能不要应用在分屏显示场景下。

业务流程

成功对接效果图：

配置SDK

在接入一键登录之前，请先确认已经集成个验SDK。下文使用到的资源文件，均可在官网下载的SDK资源包中获得。调用一键认证接口前请先完成个验SDK的接入与初始化。

maven接入方式

在模块级 build.gradle 中的dependencies块中添加elogin sdk依赖，如下：

dependencies {
    implementation 'com.getui:gysdk:2.3.1.0'
    implementation 'com.getui:elogin:1.3.1.0'
    implementation 'com.getui:gtc:3.2.4.0'
}

aar 包接入方式

（1）添加 aar包文件

将官网下载下来的 aar包 放置到项目的libs目录下

（2）配置 build.gradle

在模块级 build.gradle 中的dependencies块中添加elogin sdk依赖，如下：

    defaultConfig {
         ....
    }

    repositories {
    flatDir {
        dirs 'libs'
    }
   }

    dependencies {
        // 添加个验 aar 依赖，name与aar包的名字同步，此处的 ${version} 对应您当前相应的 SDK 版本号
        implementation(name: 'gysdk-${version}', ext: 'aar')  
        implementation(name: 'gtc-${version}', ext: 'aar')
        //添加一键登录
        implementation(name: 'elogin-${version}', ext: 'aar')
    }

配置授权页activity

在AndroidManifest文件中配置以下activity。

        <activity
             android:name="com.g.gysdk.view.ELoginActivity"
             android:configChanges="orientation|keyboardHidden|screenSize"
             android:launchMode="singleTop"
             android:screenOrientation="behind" />
         <activity
             android:name="com.g.gysdk.view.ELoginWebActivity"
             android:configChanges="orientation|keyboardHidden|screenSize"
             android:launchMode="singleTop"
             android:screenOrientation="behind" />

混淆配置

-dontwarn com.g.gysdk.**
-keep class com.g.gysdk.**{*;}
-dontwarn com.g.elogin.**
-keep class com.g.elogin.**{*;}
-dontwarn com.cmic.sso.sdk.**
-keep class com.cmic.sso.sdk.** {*;}
-dontwarn com.unicom.xiaowo.login.**
-keep class com.unicom.xiaowo.login.** {*;}
-dontwarn cn.com.chinatelecom.**
-keep class cn.com.chinatelecom.** {*;}

接口列表

API 类名: com.g.gysdk.GYManager

预登录

    /**
     * 预登录.
     *
     * @param timeout    超时时间.
     * @param gyCallBack 回调.
     */
    public void ePreLogin(int timeout, GyCallBack gyCallBack);

注意：

• 在调用一键登录接口之前，必须先预登录，预登录成功之后才可以一键登录。预登录是一个耗时操作，我们建议开发者提前进行预登录，例如在闪屏页面或者其他任何地方，这样可以在调用一键登录的时候节省用户等待的时间。
• 预登录的结果在一定时间内有效，具体的有效期会在预登录成功的结果里面返回。其中电信和移动的预登录结果在有效期内只能使用一次，联通的可以使用多次。SDK提供了isPreLoginResultValid接口来帮助开发者判断当前的预登录结果是否有效.
• 预登录成功表示当前设备可以使用一键登录，失败则表示不可用，开发者在失败的时候可以换成其他登录方式。

输入参数

调用示例

 GYManager.getInstance().ePreLogin(5000, new GyCallBack() {
            @Override
            public void onSuccess(GYResponse response) {
                showToast("预登录成功");
                Log.d(TAG, "response:" + response);
            }

            @Override
            public void onFailed(GYResponse response) {
                showToast("预登录失败:" + response);
            }
        });

返回示例

预登录会通过GyCallBack返回结果.

GyCallBack:

public interface GyCallBack {

    /**
     * description:预登录成功.
     */
    void onSuccess(GYResponse response);

    /**
     * description:预登录失败.
     */
    void onFailed(GYResponse response);

}

GYResponse返回示例:

预登录成功:
{
    gyuid='1f4b078f06ad4867b641f1976a172f1232', 
    success=true,
    code=30000,
    msg='{"msg":"103000","process_id":"bd9304d883149fd24e345ee9b1deb86f","operatorType":"CM","clienttype":1,"accessCode":"","number":"187****7325","expireTime":1574235119343}'
}
预登录失败:
{
    gyuid='1f4b078f06ad4867b641f1976a172f1232', 
    success=false, 
    code=30005, 
    msg='{"errorCode":"-40301","process_id":"6684c251a45717e57105af385649d5f4","metadata":{"msg":"timestamp-out-of-date","result":-10009},"operatorType":"CT","clienttype":"1","msg":"-10009"}',
}

• 类 GYResponse 属性详细说明：

• GYResponse中msg详细信息解释：

预登录成功时msg：

预登录失败时msg：
当code码为30005的时候，msg是一个包含预登录失败具体信息的JSON字符串。其余的情况msg为code码的简单说明,例如网络异常。以下是code为30005的时候，msg中具体信息说明：

当前版本预登录返回的信息仅作为状态记录或者异常排查，不能用于其他接口，例如服务端取号或者号码验证。

判断预登录结果是否可用

    /**
     * 判断预登录结果是否可用,返回true则表示可用.
     */
    public boolean isPreLoginResultValid();

调用示例

        //检查预登录是否有效 有效则直接登录  无效则需要先进行预登录
        if (GYManager.getInstance().isPreLoginResultValid()) {
            //可以直接调用一键登录
            ...
        } else {
              //需要先调用预登录
            ...
        }

一键登录

    /**
     * 一键登录.
     *
     * @param config   界面配置参数.
     * @param callBack 一键登录回调.
     */
    public void eAccountLogin(ELoginThemeConfig config, GyCallBack callBack);   

输入参数

ELoginThemeConfig说明

创建示例

ELoginThemeConfig.Builder builder = new ELoginThemeConfig.Builder();
        //设置背景
builder.setAuthBGImgPath("login_bg")
        //设置状态栏颜色 字体颜色
       .setStatusBar(Color.WHITE, Color.WHITE, true)
       //设置标题栏布局
       .setAuthNavLayout(Color.WHITE, 49, true, false)
       ...

return builder.build();

方法说明

setAuthBGImgPath(String authBGImgPath)

设置背景图⽚

参数说明

setAuthGifBGUriPath(String authGifBGUriPath)

设置gif背景

参数说明

具体的使用请参考demo.

setAuthVideoBGPath(String authVideoBGPath)

设置视频背景

参数说明

具体的使用请参考demo.

setAuthBGDrawable(Drawable authBGDrawable)

设置drawable背景，优先于setAuthBGImgPath，覆盖在setAuthGifBGUriPath和setAuthVideoBGPath上面

参数说明

具体的使用请参考demo.

setDialogTheme(boolean isDialogTheme, int dialogWidth, int dialogHeight, int dialogX, int dialogY, boolean isDialogBottom, boolean isWebViewDialogTheme)

设置弹窗主题相关

参数说明

setStatusBar(int statusBarColor,int navigationBarColor,boolean isLightColor)

设置状态栏颜色、字体颜色。

参数说明

setAuthNavLayout(int navColor, int authNavHeight, boolean authNavTransparent, boolean authNavGone)

设置标题栏布局

参数说明

setAuthNavTextView(String navText, int navTextColor, int navTextSize, boolean navTextNormal, String navWebViewText, int navWebViewTextColor, int navWebViewTextSize)

设置标题栏中间文字相关

参数说明

setAuthNavTextViewTypeface(Typeface navTextTypeface,Typeface navWebViewTextTypeface)

设置标题栏中间文字的字体相关

参数说明

setAuthNavReturnImgView(String navReturnImgPath, int returnImgWidth, int returnImgHeight, boolean navReturnImgHidden, int returnImgOffsetX)

设置标题栏返回按钮相关

参数说明

setLogoImgView(String logoImgPath, int logoWidth, int logoHeight, boolean logoHidden, int logoOffsetY, int logoOffsetY_B, int logoOffsetX)

设置logo相关

参数说明

setNumberView(int numberColor, int numberSize, int numFieldOffsetY, int numFieldOffsetY_B, int numFieldOffsetX)

设置号码相关

参数说明

setNumberViewTypeface(Typeface numberViewTypeface)

设置号码栏字体相关

参数说明

setSwitchView(String switchText, int switchColor, int switchSize, boolean switchAccHidden, int switchAccOffsetY, int switchOffsetY_B, int switchOffsetX)

设置切换账号相关

参数说明

setSwitchViewTypeface(Typeface switchViewTypeface)

设置切换账号字体相关

参数说明

setLogBtnLayout(String loginImgPath, int logBtnWidth, int logBtnHeight, int logBtnOffsetY, int logBtnOffsetY_B, int logBtnOffsetX)

设置登录按钮布局

参数说明

setLogBtnTextView(String loginButtonText, int loginButtonColor, int logBtnTextSize)

设置登录按钮中间文字相关

参数说明

setLogBtnTextViewTypeface(Typeface logBtnTextViewTypeface)

设置登录按钮中间文字的字体相关

参数说明

setLogBtnLoadingView(String loadingView, int loadingViewWidth, int loadingViewHeight, int loadingViewOffsetRight)

设置loading图片相关

参数说明

setSloganView(int sloganColor, int sloganSize, int sloganOffsetY, int sloganOffsetY_B, int sloganOffsetX)

设置Slogan相关

参数说明

setSloganViewTypeface(Typeface sloganViewTypeface)

设置slogan文字的字体相关

参数说明

setPrivacyLayout(int privacyLayoutWidth, int privacyOffsetY, int privacyOffsetY_B, int privacyOffsetX,boolean isUseNormalWebActivity)

设置隐私条款布局

参数说明

setPrivacyCheckBox(String unCheckedImgPath, String checkedImgPath, boolean privacyState, int privacyCheckBoxWidth, int privacyCheckBoxHeight)

设置隐私条款选择框相关

参数说明

setPrivacyClauseView(int baseClauseColor, int color, int privacyClauseTextSize)

设置隐私条款字体相关

参数说明

setPrivacyClauseViewTypeface(Typeface privacyClauseBaseTextViewTypeface,Typeface privacyClauseTextViewTypeface)

设置隐私栏文字的字体相关

参数说明

setPrivacyTextView(String privacyTextViewTv1, String privacyTextViewTv2, String privacyTextViewTv3, String privacyTextViewTv4)

设置除了隐私条款其他的字体相关

参数说明

setPrivacyClauseText(String clauseNameOne, String clauseUrlOne, String clauseNameTwo, String clauseUrlTwo, String clauseNameThree, String clauseUrlThree)

设置开发者隐私条款相关。

自定义隐私条款顺序。按顺序设置，当有条款名称与条款URL一起为空时，则使用默认的运营商隐私条款。否则按照顺序排列，自定义隐私条款最多只能两个。

参数说明

setPrivacyClauseTextStrings(String... privacyClauseTextStrings)

设置多个开发者隐私条款相关。

自定义多个隐私条款。按顺序设置，长度为 4 的倍数，配置后优先使用该接口的配置，否则使用setPrivacyClauseText的配置。可通过预留一组空字符串配置让 SDK 自动添加运营商协议。

每四个String的含义为：连接符、隐私协议名、隐私协议地址、连接符。

参数说明

调用示例

  builder.setPrivacyClauseTextStrings(
    "登录即认可", "", "", "",
    "、", "自定义协议1", "https://www.getui.com/cn/index.html?f=3&p=1", "",
    "、", "自定义协议2", "https://www.getui.com/cn/index.html?f=3&p=1", "",
    "和", "自定义协议3", "https://www.getui.com/cn/company.html", "并使⽤用本机号码登录")

setPrivacyUnCheckedToastText(String privacyUnCheckedToastText)

设置未同意隐私条款的文字提示相关。

参数说明

具体的使用请参考demo.

setShowPrivacyUncheckedToast(boolean showPrivacyUncheckedToast)

设置是否显示 未同意隐私条款的文字提示相关。

参数说明

具体的使用请参考demo.

setHasQuotationMarkOnCarrierProtocol(boolean hasQuotationMarkOnCarrierProtocol)

设置是否显示 运营商隐私额协议的书名号。

参数说明

具体的使用请参考demo.

另外,开发者可以对单个参数进行设置，每个参数都有相应的set方法，例如：
setPrivacyCheckBox(String unCheckedImgPath, String checkedImgPath, boolean privacyState, int privacyCheckBoxWidth, int privacyCheckBoxHeight)设置了隐私复选框的一系列属性，如果开发者只想对其中一项属性进行设置，可以调用相关的set方法。例如修改选中状态（privacyState）可以使用以下方法：

setPrivacyState(boolean privacyState)

备注

• 图片资源放在drawable目录下，可以是一张图片，也可以是一个xml文件。
• 设置的长宽和距离的单位为dp，文字大小的单位为sp。颜色用16进制表示。

如果开发者的项目中用到andResGuard,需要配置以下白名单:

andResGuard {
    whiteList = [
            // for gysdk
            "R.drawable.gt_*",
            "R.drawable.umcsdk_*",
            "R.drawable.gy_*",
            "R.layout.gt_*",
            "R.layout.gy_*",
            "R.id.gt_*",
            "R.id.gy_*",
            "R.anim.umcsdk_*",
            "R.style.gy_*",
            "R.string.gt_*"
            // 其他一键登录使用到的资源
            ...
    ]
}

调用示例

ELoginThemeConfig.Builder builder = new ELoginThemeConfig.Builder();
        //设置背景
builder.setAuthBGImgPath("login_bg")
        //设置状态栏颜色 字体颜色
       .setStatusBar(Color.WHITE, Color.WHITE, true)
       //设置标题栏布局
       .setAuthNavLayout(Color.WHITE, 49, true, false)
       ...  

GYManager.getInstance().eAccountLogin(builder.build(), new GyCallBack() {
                    @Override
                    public void onSuccess(GYResponse response) {
                        Log.d(TAG, "response:" + response);
                        //关闭验证界面
                        GYManager.getInstance().finishAuthActivity();
                        showToast("登录成功");                                            
                    }

                    @Override
                    public void onFailed(GYResponse response) {
                        Log.d(TAG, "response:" + response);
                        showToast("一键登录失败:" + response);
                        //关闭验证界面
                        GYManager.getInstance().finishAuthActivity();
                    }
                });

返回示例

一键登录会通过GyCallBack返回结果.

GyCallBack:

public interface GyCallBack {

    /**
     * description:登录成功.
     */
    void onSuccess(GYResponse response);

    /**
     * description:登录失败.
     */
    void onFailed(GYResponse response);

}

GYResponse返回示例:

成功示例：
{
    gyuid='20827b1266924eb691b61f4a538222f232', 
    success=true, 
    code=30000,             
    msg='{"verifyType":0,"data":{"token":"je3o9NNU0w6kpyDEBpIdC4","expiredTime":1553139758029}}'
}
失败示例：
{
    gyuid='8f41f31b0e7a43e6bbb4d1e6da77489b62', 
    success=false, 
    code=30006,
    msg='{"errorCode":"-40301","process_id":"6684c251a45717e57105af385649d5f4","metadata":{"msg":"timestamp-out-of-date","result":-10009},"operatorType":"CT","clienttype":"1","msg":"-10009"}'
}

• 类 GYResponse 属性详细说明：

• 登录成功的时候 msg说明:

登录成功的时候，GYResponse中的msg会是如下的JSON格式字符串.

//一键登录成功
{
    "msg":{
            "verifyType":0,
            "data":{
                "token":"qUiRvTAFLeAb36ubCtpcj",
                "expiredTime":1552887621123
            }
    }
}

一键登录成功返回参数解释：

• 登录失败的时候msg说明:

登录失败的时候，GYResponse中的msg会包含错误的详细信息。在code为30006的时候，msg是一个JSON字符串，其余情况msg是code码的简单解释信息,例如网络异常。

以下是登录失败后，code为30006时msg中信息的解释：

添加自定义控件

    /**
     * 一键登录界面添加自定义控件.
     *
     * @param id         控件名称.
     * @param viewConfig 控件配置.
     */
    public void addRegisterViewConfig(String id, AuthRegisterViewConfig viewConfig)

在调用eAccountLogin之前，开发者可以在授权页面titlebar和body添加自定义的控件。
注意：自定义的控件不允许覆盖SDK默认的UI。

输入参数

调用示例

Button mTitleBtn = new Button(context);
        mTitleBtn.setText("其他");
        mTitleBtn.setTextColor(0xff000000);
        mTitleBtn.setTextSize(TypedValue.COMPLEX_UNIT_SP, 14);
        mTitleBtn.setBackgroundColor(Color.TRANSPARENT);
        RelativeLayout.LayoutParams mLayoutParams = new RelativeLayout.LayoutParams(RelativeLayout.LayoutParams.WRAP_CONTENT, RelativeLayout.LayoutParams.WRAP_CONTENT);
        mLayoutParams.addRule(RelativeLayout.ALIGN_PARENT_RIGHT, RelativeLayout.TRUE);
        mTitleBtn.setLayoutParams(mLayoutParams);

GYManager.getInstance().addRegisterViewConfig("title_button", new AuthRegisterViewConfig.Builder()
                .setView(mTitleBtn)
                .setRootViewId(AuthRegisterViewConfig.RootViewId.ROOT_VIEW_ID_TITLE_BAR)
                .setCustomInterface(new CustomInterface() {
                    @Override
                    public void onClick(Context context) {
                        showToast( "动态注册的其他按钮");
                    }
                })
                .build()
        );

AuthRegisterViewConfig说明:

AuthRegisterViewConfig authRegisterViewConfig =new AuthRegisterViewConfig.Builder().build();

方法说明:

设置一键登录页面回调

    /**
     * 设置一键登录界面回调.
     *
     * @param authPageListener 回调.
     */
    public void setAuthPageListener(AuthPageListener authPageListener);

开发者可以通过该方法设置一键登录页面的回调。
该接口请开发者按照自己业务需求实现，适用于埋点、自定义实现协议界面等需求。

AuthPageListener详细解释:

public interface AuthPageListener {

    /**
     * 隐私条款点击回调.
     *
     * @param name 条款名称.
     * @param url  条款url.
     */
    public void onPrivacyClick(String name, String url);

    /**
     * 隐私条款复选框点击回调.
     *
     * @param checked 复选框选中状态,true为选中.
     */
    public void onPrivacyCheckBoxClick(boolean checked);

    /**
     * 登录按钮点击回调.
     */
    public void onLoginButtonClick();

    /**
     * 授权页面拉起回调.
     */
    public void onAuthActivityCreate(Activity activity);

    /**
     * 隐私条款页面拉起回调.
     */
    public void onAuthWebActivityCreate(Activity activity);

}

调用示例

          //添加一键登录页面回调
        GYManager.getInstance().setAuthPageListener(new AuthPageListener() {
            @Override
            public void onPrivacyClick(String s, String s1) {
                Log.d(TAG, "隐私条款点击回调:" + s + ":" + s1);
            }

            @Override
            public void onPrivacyCheckBoxClick(boolean b) {
                Log.d(TAG, "隐私条款复选框点击回调:" + b);
            }

            @Override
            public void onLoginButtonClick() {
                Log.d(TAG, "一键登录按钮点击回调");
            }

            @Override
            public void onAuthActivityCreate(Activity activity) {
                Log.d(TAG, "授权页面启动回调");
            }

            @Override
            public void onAuthWebActivityCreate(Activity activity) {
                Log.d(TAG, "隐私条款页面启动回调");
            }
        });

判断隐私条款是否同意

    /**
     * .判断隐私条款是否同意
     */
    public boolean isPrivacyChecked();

通过该接口可以判断当前一键登录页面的隐私条款复选框是否被选中。

关闭授权页面的loading

    /**
     * 关闭授权页面的loading.
     */
    public void stopLoading();

用户点击一键登录按钮后，默认按钮右侧会显示一个loading的动画，该动画不会自动关闭。如果在一键登录结束后关闭界面，则不需要调用此接口。如果开发者的业务需求是不关闭界面，那么可能会用到该接口。

关闭一键登录界面

    /**
     * 关闭验证界面.
     */
    public void finishAuthActivity() 

SDK除了返回按钮触发以外，默认是不finsih授权页的，需要开发者自行实现。

关闭一键登录

    /**
     * 关闭一键登录.
     */
    public void cancelELogin();

一键登录结束后调用该方法，释放资源。

状态码（3.x版本请统一看状态码汇总）

SDK返回码

错误码

其余情况请参考状态码汇总说明

常见问题

建议开发者在开发期间开启debug模式，通过查看debug日志，可以更好的排查问题。

//在初始化之前调用
GYManager.getInstance().setDebug(true);

一键登录和本机号码校验支持哪些运营商和网络环境

目前支持移动 2G、3G、4G、5G，联通 3G、4G、5G，电信 4G、5G。

是否支持双卡手机

支持，双卡手机以开启数据流量的 SIM 卡进行认证。

WIFI环境下能否验证

在数据网络开通的前提下，WiFi 环境中会强制使用数据网络触发网关请求，请求仅为几K，可正常校验。

是否支持携号转网用户

SDK 不提供接口判断用户是否为携号转网用户，但可以判断用户流量卡当前的运营商。即携号转网用户可正常使用。

是否支持虚拟运营商

仅支持三大运营商（移动、联通、电信）的手机号进行一键登录。

是否支持流量卡

三大运营商（移动、联通、电信）的卡，能够正常使用数据网络，运营商通过网关能够正常取号，均会被作为正常的卡来判断。

是否支持分屏显示

目前一键认证不支持分屏幕显示。

部分OPPO手机上预登录失败

部分OPPO手机上新安装APP默认只有wifi网络权限，默认没有给予访问移动数据流量的权限。需要用户在设置中手动授予权限。开发者可以引导用户开启，有以下两种方案：

• 引导手动设置权限：设置->双卡与移动网络->使用WLAN与移动网络的应用->找到需要设置的APP->设置WLAN与移动数据即可
• 关闭WIFI,操作应用，会弹出使用移动网络提醒，点击设为允许，即可正常使用

其他预登录失败问题排查

• 确定手机时间是否为正常时间，非正常时间会导致预登录失败。
• 确定当前网络有无代理，代理会导致预登录失败。