イントロ

独自のカスタマイズやその他の目的でRESTfulAPIとしてBioStar2 New Local APIを使用する場合は、この記事を参照してください。この記事では、C＃コンソールアプリケーションによるBioStar 2 New Local APIの基本的な使用法について説明します。   

 


機能

この記事では、以下の機能について説明します。

  1. Send Email APIにてビジュアルフェイスを登録
  2. デバイスによるビジュアルフェイスを登録 (FaceStation F2)



この記事では、API関数を呼び出してVisualFaceをBioStar2サーバーのユーザーに登録する方法を確認します。New Local APIを介してVisualFaceを登録する方法は2つあります。

API呼び出し用に作成されたC＃プログラムのサンプルコードをご覧ください。ソースコードをコピーして貼り付けて同じ機能を使用できます。  

また、RESTfulAPI呼び出しに使用するプログラムであるPostmanを介してAPI関数を呼び出す方法も確認します。


* VisualFace登録用のEメールを送信するためにクラウドとメールの設定が必要です。

クラウドの設定は、リンクを参照してください。

*メールを送信してVisualFaceを登録する機能を使用するように、メール送信オプションの設定が必要です。

メール送信オプションを設定するには、以下の手順に従ってください。

また、RESTfulAPI呼び出しに使用するプログラムであるPostmanを介してAPI関数を呼び出す方法も確認します。 


*メールを送信してVisualFaceを登録する機能を使用するように、メール送信オプションの設定が必要です。 メール設定は以下の手順に従ってください。

  1. Biostar 2 > 設定 > メール設定

텍스트, 전자기기이(가) 표시된 사진 자동 생성된 설명

 

  1. 「SMTP設定」をクリックし、適切な値を入力します。


  1. メール用に設定する場合は、[Visual Face Mobile Enrollment]を有効にし、追加のオプション（メールの件名、会社名、会社ロゴ、連絡先）を入力します。

텍스트이(가) 표시된 사진 자동 생성된 설명


  1. ユーザーのメールアドレスを登録します。


  • SMTP設定とVisualFace Mobile Enrollment設定のセットアップ方法の詳細については、リンクをご覧ください。

 

 

Part 1. API呼び出しとパラメーター    

 

[POST]: /api/v2/send_email

[パラメーター] 

名称

タイプ

*M/O

説明

バリュー

Id

String

O

選択したユーザーのID

 

Language

String

O

メール送信の言語

英語は“en”

   * M – 必須, O – オプション

 

Part 2. リクエストボディとレスポンスモデル   

[値の例/パラメーターモデル]

{

     "id": "2",

     "language": "en"

}

 

[レスポンスモデル]

{

  "code": "0",

  "httpResponseStatus": 200

}


[レスポンス: 失敗]

{

    "code": "1000"

}


[レスポンス: 成功]

{

    "code": "0"

}

 


Part 3. コンソール例

 

[メール送信（ビジュアルフェイス登録）のソースコード] 

static async void EmailVisualFaceReg()

        {

            Console.WriteLine("*****EmailVisualFaceReg Task Started*****");

            CookieContainer cookieContainer = new CookieContainer();

 

            HttpClientHandler handler = new HttpClientHandler();

            handler.CookieContainer = cookieContainer;

 

            HttpClient httpClient = new HttpClient(handler);

 

            HttpClient client = new HttpClient(handler);

               httpClient.DefaultRequestHeaders.Add("bs-session-id", sessionID);

            cookieContainer.Add(new Uri("https://127.0.0.1"), new Cookie("bs-session-id", sessionID));

            ListUsers();

            Console.WriteLine("Select User ID for Visual Face Registration via Email...");

            string userID = Console.ReadLine();

            string resourceAddress = "https://127.0.0.1/api/v2/send_email/";

 

            JavaScriptSerializer serializer = new JavaScriptSerializer();

 

            string payload = "{ \"id\": \"" + userID + "\", \"language\": \"en\"}";

            Console.WriteLine(payload);

            StringContent sc = new StringContent(payload, Encoding.UTF8, "application/json");

            //HttpResponseMessage httpResponse = await httpClient.PostAsync(resourceAddress, sc);

            HttpResponseMessage httpResponse = httpClient.PostAsync(resourceAddress, sc).Result;

 

            if (httpResponse.IsSuccessStatusCode == true)

            {

                Console.WriteLine("Email Sent. Check your Email.");

                string httpResponseBody = await httpResponse.Content.ReadAsStringAsync();

                   Console.WriteLine(httpResponseBody);

            }

            else

            {

                Console.WriteLine("Email Send Failed.");

                   Console.WriteLine(httpResponse.ToString());

            }

        }

 

[メール送信（ビジュアルフェイス登録）成功] 

텍스트이(가) 표시된 사진 자동 생성된 설명

 

[メール送信]

 

 

 

Part 4. Postmanにてビジュアルフェイス登録 

 

[リクエスト] 

*メールアドレスが登録されているユーザーのIDを入力してください。

 

[Response Body: 成功]