REST API 概要

基本的な制約

• APIはHTTP、REST仕様に準拠するように設計されています。例えば、クエリリクエストにはGETメソッド、送信リクエストにはPOSTメソッドを使用します。リクエストが対応するHTTPメソッドでない場合、エラーが返されます。
• 特に指定がない限り、パラメータ値はUTF-8、URLエンコードに変換する必要があります。

データセンターとBase URL

REST APIを使用する場合、選択したbase URLと特定のAPIパスを組み合わせて、完全な呼び出しアドレスを取得する必要があります。

              
              {base URL}/{APIパス}

            

認証方式

EngageLab REST APIはHTTP基本認証を採用しています：HTTP Header（ヘッダー）にAuthorizationを追加します：

              
              Authorization: Basic ${base64_auth_string}

            

上記のbase64_auth_stringの生成アルゴリズムは：base64(api_key:api_secret)

• Header名は"Authorization"で、値はbase64変換された"username:password"ペア（間にコロンが入ります）です。
• LiveDesk APIのシナリオでは、usernameはAPI Key、passwordはAPI Secretです。「プロジェクト設定-API管理」でAPIタイプのデータソースを追加して、API KeyとAPI Secretを取得してください。