系列目录 【已更新最新开发文章，点击查看详细】
BIMFACE 平台为开发者提供了大量的服务器端 API 与 JavaScript API，用于二次开发 BIM 的相关应用。
BIMFACE 所有的 RESTful API 都有对应的鉴权机制保护，目前 BIMFACE 支持两种鉴权方式：
-
Access token
代表自身应用的身份，使用应用的 appkey, secret，通过调用/oauth2/token接口获取。
View token
代表对单个模型/集成模型/模型对比的访问权限，使用 access token，通过调用/view/token或其他相关接口获得。
使用 Access token，可以对自己应用内的文件发起文件上传，下载，删除，模型转换，模型集成，模型对比等操作， 同时也能访问所有 BIMFACE 的数据接口获取转换后的模型BIM信息；而 View token 只代表对单个模型/集成模型/模型对比的临时的访问凭证， 只能访问对应模型的数据接口，通过使用应用的 Access token 调用下面的接口可以获得。 通常情况下，View token 可以直接传入前端 JSSDK 用来加载/浏览模型。
Access token 有效期为7天, 除非 token 被注销，Access token 在7天内不会发生改变； 而 View token 只是一个临时的访问凭证，有效期为12小时。但是为了减少用户重复请求 View token 的次数， 每次使用 View token 都会重置有效期为12小时。这样如果你的模型持续有人访问，View token 会一直有效， 只有在12小时内，没有使用 View token 的任何调用，View token 才会失效。
Access token 只能使用 appkey, secret 通过/oauth2/token接口获取； 类似的，View token 必须通过有效的 Access token 并提供对应的源文件Id以及集成模型Id信息来获取。
关于请求中的 Header Authorization 的使用
获取 Access token 接口中使用的 Authorization，是将字符串 appKey:appSecret 拼接后（中间用冒号连接），对其进行BASE64编码， 然后在编码后的字符串前添加字符串Basic和一个空格， 即：“Basic [Base64Encode(“appKey:appSecret”)]“。
其他接口中使用的 Header Authorization， 是将你的 Access token 的字符串前添加字符串bearer和一个空格，
即：“bearer [access token]" 。
BASE64编码与解码的方法：
/// <summary>
/// 使用 UTF8 编码格式，对字符串进行进行 Base64 方式编码（加密）
/// </summary>
/// <param name="this">扩展对象</param>
/// <returns>编码后的字符串</returns>
public static string EncryptByBase64(this string @this)
{
byte[] bytes = Encoding.UTF8.GetBytes(@this);
return Convert.ToBase64String(bytes);
}
/// <summary>
/// 使用 UTF8 编码格式，对字符串进行进行 Base64 方式解码（解密）
/// </summary>
/// <param name="this">扩展对象</param>
/// <returns>解码后的字符串</returns>
public static string DecryptByBase64(this string @this)
{
byte[] bytes = Convert.FromBase64String(@this);
return Encoding.UTF8.GetString(bytes);
}
获取 AccessToken
请求地址：POST https://api.bimface.com/oauth2/token
说明：在调用其他API之前，必须先获取Access Token。Access Token的有效期为7天。
参数：
获取AccessToken的方法：
/// <summary>
/// 获取访问服务端其他API的令牌
/// </summary>
/// <param name="appKey">秘钥</param>
/// <param name="appSecret">密码</param>
/// <returns></returns>
public AccessTokenResponse GetAccessToken(string appKey, string appSecret)
{
//POST https://api.bimface.com/oauth2/token
string url = BimfaceConstants.API_HOST + "/oauth2/token"; BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
headers.AddBasicAuthHeader(appKey, appSecret); try
{
AccessTokenResponse response;
HttpManager httpManager = new HttpManager(headers);
HttpResult httpResult = httpManager.Post(url);
if (httpResult.Status == HttpResult.STATUS_SUCCESS)
{
response = httpResult.Text.DeserializeJsonToObject<AccessTokenResponse>();
}
else
{
response = new AccessTokenResponse
{
Message = httpResult.RefText
};
} return response;
}
catch (Exception ex)
{
throw new Exception("获取 AccessToken 时发生异常！", ex);
}
}
在网页中测试上面的方法：
/// <summary>
/// 获取 AccessToken
/// </summary>
protected void btnGetAccessToken_Click(object sender, EventArgs e)
{
string token = string.Empty;
string appKey = ConfigUtility.GetAppSettingValue("BIMFACE_AppKey");
string appSecret = ConfigUtility.GetAppSettingValue("BIMFACE_AppSecret"); IBasicApi api = new BasicApi();
AccessTokenResponse response = api.GetAccessToken(appKey, appSecret);
if (response != null)
{
token = response.Data.Token;
}
}
在监视窗口中可以看到，接口调用返回了正确的结果：
在调试窗口中也可以看到正确的响应结果：
上述方法中调用到的 httpManger.Post(url)方法
/// <summary>
/// HTTP-POST方法，(不包含body数据)。
/// 发送 HTTP 请求并返回来自 Internet 资源的响应(HTML代码)
/// </summary>
/// <param name="url">请求目标URL</param>
/// <returns>HTTP-POST的响应结果</returns>
public HttpResult Post(string url)
{
return RequestString(url, null, WebRequestMethods.Http.Post, null);
}
/// <summary>
/// HTTP请求(包含文本的body数据)
/// </summary>
/// <param name="url">请求目标URL</param>
/// <param name="data">主体数据(普通文本或者JSON文本)。如果参数中有中文，请使用合适的编码方式进行编码，例如：gb2312或者utf-8</param>
/// <param name="method">请求的方法。请使用 WebRequestMethods.Http 的枚举值</param>
/// <param name="contentType"><see langword="Content-type" /> HTTP 标头的值。请使用 ContentType 类的常量来获取</param>
/// <returns></returns>
private HttpResult RequestString(string url, string data, string method, string contentType)
{
HttpResult httpResult = new HttpResult();
HttpWebRequest httpWebRequest = null; try
{
httpWebRequest = WebRequest.Create(url) as HttpWebRequest;
httpWebRequest.Method = method;
httpWebRequest.Headers = HeaderCollection;
httpWebRequest.CookieContainer = CookieContainer;
if (!string.IsNullOrWhiteSpace(contentType))
{
httpWebRequest.ContentType = contentType;// 此属性的值存储在WebHeaderCollection中。如果设置了WebHeaderCollection，则属性值将丢失。所以放置在Headers 属性之后设置
}
httpWebRequest.UserAgent = _userAgent;
httpWebRequest.AllowAutoRedirect = _allowAutoRedirect;
httpWebRequest.ServicePoint.Expect100Continue = false; if (data != null)
{
httpWebRequest.AllowWriteStreamBuffering = true;
using (Stream requestStream = httpWebRequest.GetRequestStream())
{
requestStream.Write(EncodingType.GetBytes(data), , data.Length);//将请求参数写入请求流中
requestStream.Flush();
}
} HttpWebResponse httpWebResponse = httpWebRequest.GetResponse() as HttpWebResponse;
if (httpWebResponse != null)
{
GetResponse(ref httpResult, httpWebResponse);
httpWebResponse.Close();
}
}
catch (WebException webException)
{
GetWebExceptionResponse(ref httpResult, webException);
}
catch (Exception ex)
{
GetExceptionResponse(ref httpResult, ex, method, contentType);
}
finally
{
if (httpWebRequest != null)
{
httpWebRequest.Abort();
}
} return httpResult;
}
获取 ViewToken
请参考《C#开发BIMFACE系列15 服务端API之获取模型的View token》。
系列目录 【已更新最新开发文章，点击查看详细】
