Bit_Login / Bit_LoginEx

BIT_STATUS BIT_CALLCONV Bit_Login(
    BIT_PCSTR      szURL,
    BIT_PCSTR      szSN,
    BIT_UCHAR      *pApplicationData,
    BIT_HANDLE     *pHandle,
    LOGIN_MODE     mode);

BIT_STATUS BIT_CALLCONV Bit_LoginEx(
    BIT_PCSTR      szURL,
    BIT_PCSTR      szSN,
    BIT_UINT32     featureId,
    BIT_PCSTR      szReserved,
    BIT_UCHAR      *pApplicationData,
    BIT_HANDLE     *pHandle,
    LOGIN_MODE     mode);

授权登录。初始化运行环境，获取操作句柄。必须在除升级函数之外的其它操作前执行。根据登录模式的不同可能需要连接授权服务器。

Bit_Login等价于Bit_LoginEx(…, featured=0，szReserved=NULL, …)，当需要登录包含指定特征项的授权时才需要调用Bit_LoginEx。

参数

• szURL - [IN] 自定义授权服务地址，包括端口，如未使用自定义授权服务器则为NULL。授权服务地址可以是网络地址、本地授权目录以及license串。

允许设置多个授权路径，通过“，”拆分。

如下：

lic:///tmp,lic:///data,bit://127.0.0.1:8273
/tmp,/data,127.0.0.1:8273  // 等价第1条

注意：该接口支持通过配置文件和环境变量来设置该值，如果同时设置优先级为：环境变量 > API传入 > 配置文件。

• szSN - [IN] 授权码（SN）字符串。如果为空（空串或NULL）则尝试寻找所有当前本机可用的SN。

• featureId - [IN] 登录授权所需要包含的特征项ID。
• szReserved - [IN] 一个xml串，可以传入特征项版本，如果不需要可以为NULL。

  xml格式如下：

<scope>
    <featureVersion>{特征项版本}</featureVersion>
</scope>

• pApplicationData - [IN] 产品识别码，在Bitanswer SDK头文件里。
• pHandle - [OUT] 通过Login函数返回的上下文句柄。
• mode - [IN] 登录模式，按位操作。

示例

// 使用高性能模式检查集团授权
BIT_HANDLE handle = NULL;
BIT_STATUS status = Bit_Login(
    NULL, NULL, application_data,
    &handle, LOGIN_MODE(BIT_MODE_REMOTE | LOGIN_MODE_HIGH_PERFORMANCE ));
if (status == BIT_SUCCESS) {
    // 校验成功
}

// 使用Session + 长连接模式检查集团授权
BIT_HANDLE handle = NULL;
BIT_STATUS status = Bit_Login(
    NULL, NULL, application_data,
    &handle, LOGIN_MODE(BIT_MODE_REMOTE | LOGIN_MODE_SESSION  | LOGIN_MODE_PERSISTENT_CONN ));
if (status == BIT_SUCCESS) {
    // 校验成功
}

// 使用内存license
BIT_HANDLE handle = NULL;
BIT_CHAR *pLicense = “lic://xxxxxxx”;
BIT_STATUS status = Bit_Login(pLicense, NULL, application_data, &handle, BIT_MODE_AUTO);
if (status == BIT_SUCCESS) {
    // 校验成功
}

// 先检查单机授权吗，如果没有再检查集团授权或云授权
BIT_HANDLE handle = NULL;
BIT_STATUS status = Bit_Login(NULL, NULL, application_data, &handle, BIT_MODE_AUTO);
if (status == BIT_SUCCESS) {
    // 校验成功
}

// 检查包含指定特征项的授权
BIT_HANDLE handle = NULL;
BIT_UINT32 featureId = 1;
BIT_STATUS status = Bit_LoginEx(NULL, NULL,  featureId, NULL, application_data, &handle, BIT_MODE_AUTO);
if (status == BIT_SUCCESS) {
    // 校验成功
}

Bit_LoginByToken / Bit_LoginByTokenEx

BIT_STATUS BIT_CALLCONV Bit_LoginByToken(
    BIT_PCSTR      pUrl,
    BIT_PCSTR      pToken,
    BIT_UCHAR      *pApplicationData,
    BIT_HANDLE     *pHandle)

BIT_STATUS BIT_CALLCONV Bit_LoginByTokenEx(
    BIT_PCSTR      pUrl,
    BIT_PCSTR      pBusinessGuid,
    BIT_PCSTR      pToken,
    BIT_PCSTR      pIdpGuid,
    BIT_PCSTR      pGrantType,
    BIT_UCHAR      *pApplicationData,
    BIT_HANDLE     *pHandle)

帐号授权的登录接口。

仅支持两种认证方式：第一种是使用OIDC协议产生的id_token认证，第二种是使用比特授权云平台自己产生的access_token进行认证。

参数

• pUrl - [IN] 服务器地址，可以为空。
• pBussinessGuid - [IN] 业务guid，在比特授权云平台获取。
• pToken - [IN] 第三方身份源颁发的token或id_token，通过前缀区分。

• pIdpGuid - [IN] 第三方身份源guid，在比特授权云平台获取。参数为空表示使用比特授权云平台产生的token进行登录，即Bit_LoginByToken。
• pGrantType - [IN] 授权类型。固定值为“bitanswer:idp:oidc:id_token”。
• pApplicationData - [IN] 产品识别码，记录在接口定义文件中，与产品一一对应。
• pHandle - [OUT] 通过Login函数返回的上下文句柄。

Bit_LoginByPassword

BIT_STATUS BIT_CALLCONV Bit_LoginByPassword(
    BIT_PCSTR       szURL,
    BIT_PCSTR       szBusinessGuid,
    BIT_PCSTR       szBusinessSecret,
    BIT_PCSTR       szAccount,
    BIT_PCSTR       szPassword,
    BIT_UCHAR       *pApplicationData,
    BIT_HANDLE      *pHandle);

通过用户名和密码登录账号授权。

参数

• szURL - [IN] 服务器地址，可以为空。
• pBussinessGuid - [IN] 业务编号，在比特授权云平台获取。
• szBusinessSecret [IN] 业务密钥，在比特授权云平台获取。
• szAccount - [IN] 用户账号。
• szPassword - [IN] 用户密码。
• pApplicationData - [IN] 产品识别码，记录在接口定义文件中，与产品一一对应。
• pHandle - [OUT] 通过Login函数返回的上下文句柄。

Bit_Logout

BIT_STATUS Bit_Logout (
    BIT_HANDLE handle)

此函数用于释放上下文句柄，退出登录状态，与Login相关接口一一对应。

参数

• handle - [IN] 通过Login函数返回的上下文句柄。

Bit_Revoke

BIT_STATUS Bit_Revoke (
    BIT_PCSTR     szURL,
    BIT_PCSTR     szSN,
    BIT_UCHAR     *pApplicationData,
    BIT_CHAR      *pRevocationInfo,
    BIT_UINT32    *pRevocationInfoSize)

从客户端迁出已激活的浮动授权码。授权码迁出后，可以用于其它的客户端。根据输入参数的不同，本函数可用于在线或离线迁出。

参数

• szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
• szSN - [IN] 授权码（SN）字符串。
• pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
• pRevocationInfo - [OUT] 迁出请求码的存储区地址。为NULL表示进行在线迁出，否则API将执行手工离线迁出，请求码应发给服务器进行确认。
• pRevocationInfoSize - [IN/OUT] 输入时为请求码存储区大小，输出时为请求码长度。如此参数为NULL，函数将选择在线迁出。

Bit_RemoveSn

BIT_STATUS Bit_RemoveSn (
    BIT_PCSTR     szSN,
    BIT_UCHAR     *pApplicationData)

删除指定授权码在本机的授权数据。

参数

• szSN - [IN] 授权码（SN）字符串。
• pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。

Bit_Heartbeat

BIT_STATUS BIT_CALLCONV Bit_Heartbeat(
    BIT_HANDLE     handle,
    BIT_UINT32     *pReconnectsNum)

手动心跳。

参数

• handle - [IN] 通过Login函数返回的上下文句柄。
• pReconnectsNum - [OUT] 保存心跳失败次数，开发上可以根据该次数决定是否退出程序。

Bit_SessionControl

BIT_STATUS BIT_CALLCONV Bit_SessionControl(
    BIT_PCSTR     szURL,
    BIT_PCSTR     pSessionId,
    BIT_UINT32    type,
    BIT_UCHAR     *pApplicationData,
    BIT_CHAR      *pValue,
    BIT_UINT32    *pValueLen)

控制或设置session的信息。具体使用场景可参考《浏览器并发控制》文档。

参数

• szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
• pSessionId - [IN] Login后的sessionId，通过Bit_GetSessionInfo可以获取。
• type - [IN] 类型。

• pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
• pValue - [OUT] 数据缓存区。
• pValueLen - [IN/OUT] 输入时是数据缓存区的大小，输出时是实际数据长度。

Bit_SetSessionState

BIT_STATUS Bit_SetSessionState (
    BIT_HANDLE     handle,
    BIT_UINT32     state,
    BIT_VOID       *pReserved)

设置客户端的状态为空闲状态或繁忙状态或激活状态。

参数

• handle - [IN] 通过Login函数返回的上下文句柄。
• state - [IN] 设置客户端的状态选项。

• pReserved - [OUT] 目前保留必须传NULL。

示例

BIT_STATUS status = BIT_SUCCESS;
BIT_UINT32 reserved = 0;

if (用户正在操作) {
    status = Bit_SetSessionState (handle,  SESSION_STATE_ACTIVE,  &reserved);
} else if (用户空闲) {
    status = Bit_SetSessionState (handle,  SESSION_STATE_IDLE,  &reserved);
}