API接口
所有文档

          号码认证服务 PNVS

          API接口

          初始化接口

          宿主程序启动后在应用的Application类的onCreate中调用初始化接口:

          HTSSOManager.init(Context context, String appkey, String seckey);

          宿主程序需要确保在使用一键登录功能的进程中初始化本SDK。

          参数说明

          String appkey、String seckey:用于服务器的访问校验,是本SDK的渠道凭证,集成之前需要向接口人申请。这两个 key 是和集成宿主的包名和签名唯一关联的。如果包名或者签名有变化需要重新申请。

          用户授权隐私协议状态设置接口

          初始化时根据用户对隐私协议授权行为设置对应状态。

          HTSSOManager.setUserAuthPrivacyState(Context context, boolean state);

          参数说明

          1. context:上下文环境。
          2. state:用户同意隐私协议时设置为true,拒绝时设置为false。

          预取号接口

          在需要使用一键登录功能的Activity中调用,调用该接口会加速后面授权界面打开速度,强烈建议提前调用。在调用此接口时,必须确保已调用初始化接口,预取号接口提供2种。

          HTSSOManager.preLogin(Context ctx, long time0ut, new  HTSSOManager.IHTSSOLoginListener () {
                     @Override
                     public void onFinish(String info) {
                     }
                 });

          参数说明

          1. ctx:环境上下文。
          2. timeOut:接口超时时间,建议设置为5秒及以上。
          3. listener:预取号结果回调接口。
          HTSSOManager.preLogin(Context ctx, long time0ut, int operateType,
          new HTSSOManager.IHTSSOLoginListener () {
                      @Override
                      public void onFinish(String info) {
                      }
                  });

          参数说明

          1. ctx:上下文Context。
          2. timeOut:接口超时时间,建议设置为5秒及以上。
          3. operateType:选择登录的运营商类别,如已经知道当前用户手机卡为移动,则传入移动类别。可选值:1.移动 2.联通 3.电信
          4. listener:预取号结果回调接口。

          注意:

          1.首次使用运营商一键登录时,必须开启对应运营商数据流量。

          2.第一个登录接口内部判断sim卡运营商并且调用对应运营商接口,第二个接口为调用指定运营商登录接口,如果集成的为单个或者全部运营商的sdk,指定运营商参数失效。

          1. 预取号数据有效期为1小时

          打开授权页接口

          HTSSOManager.openLoginPage (Context context,long timeOut,new
            HTSSOManager.IHTSSOLoginListener() {
                      @Override
                      public void onFinish(String info) {}
                  });

          参数说明

          1. ctx:上下文Context,如果要设置界面跳转动画,此处context必须为Activity。
          2. timeOut:接口超时时间,建议设置为5秒及以上。
          3. listener:预取号结果回调接口。

          注意:调用该接口强烈建议先调用了预取号接口,能加快界面打开速度

          关闭授权页接口

          HTSSOManager.closeoPage()

          授权页面打开后,如果用户授权我们会正常返回信息,集成方决定什么时候关闭页面,如果用户取消,则我们直接关闭授权页面并且返回对应错误码。

          获取当前SIM卡运营商接口

          new HTSSOManager.getCurrentOperatorName(Context context) 

          参数说明:

          Context context:上下文Context

          返回值说明:

          CMCC:中国移动

          CTCC:中国电信

          CUCC:中国联通

          没有sim卡返回null

          设置授权界面接口

          昊天sdk内置两种样式的授权页面,集成方可以自行选择:

          全屏模式

          image.png

          弹窗模式

          image.png

          其中很多元素均提供对应接口,可以自定义您的授权页样式 (1)修改授权页样式接口

          HTSSOManager.setAuthThemeConfig(Context context,SSOAuthThemeConfig config) 

          参数说明:

          Context:环境上下文

          SSOAuthThemeConfig:授权页样式

          调用示例:

          HTSSOManager.setAuthThemeConfig(this.getApplicationContext(),
                  new SSOAuthThemeConfig.Builder(this.getApplicationContext(),
                          SSOAuthThemeConfig.TYPE_FULL_SCREEN)
          .setThemeId(R.style.auth)
          .setLogBtnText(“一键登录”)
          .setLogBtnTextColor(Color.BALCK)
          .setLogBtnImagePath(“btn_select”)
          .build());

          预取号和打开授权页回调接口

          回调结果在如下对象接口中回调:

          new HTSSOManager.IHTSSOLoginListener () {
                      @Override
                      public void onFinish(String info) {
                      }
                  });

          参数说明:

          (1)String info:回调登录结果json字符串。

          (2)结果json内容及含义

          参数 类型 说明
          “0” int 主状态码,见“状态码说明”
          “1” int 副状态码,见“状态码说明”
          “2” String 运营商标识,“1”:移动,“2”:联通,“3”:电信,“-1”:无法获取运营商标识
          3 String 登录结果,登录成功时为json格式,登录失败时为提示信息。

          (3). 登录成功json内容及含义:

          参数 类型 说明
          “data” String 主状态码,见“状态码说明”
          “errno” String 提示内容,登录成功为空。
          “msg” String 运营商标识,“1”:移动,“2”:联通,“3”:电信,“-1”:无法获取运营商标识
          “request_id“ String 请求id,用于排查问题
          上一篇
          集成步骤
          下一篇
          登录授权页