REST API の概要

基本的な制約

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

データセンターとベースURL

LiveDesk REST APIを使用する際は、選択したベースURLと各APIのパスを組み合わせて、完全なリクエストURLを作成します。

              
              {base URL}/{API path}

            

認証方式

EngageLab REST APIでは、HTTP Basic Authentication を使用します。HTTPヘッダーに Authorization を追加してください。

              
              Authorization: Basic ${base64_auth_string}

            

base64_auth_string を生成するアルゴリズムは、次のとおりです。

              
              base64(api_key:api_secret)

            

• ヘッダー名は Authorization で、値はコロンで区切った username:password のペアをBase64でエンコードしたものです。
• LiveDesk APIでは、username は API Key、password は API Secret を指します。API Key と API Secret を取得するには、Project Settings > API Management で、APIタイプのデータソースを追加してください。