APIキーとは

APIキーは、LiveAgentのID(ユーザー名とパスワードのようなもの)であり、独自のカスタム統合ソリューションを構築するために使用できます。信頼できない相手には絶対に教えないでください。APIキーが漏洩した場合は、迷わず新しいものを生成してください!APIキーを持っている人は誰でもLiveAgentに完全にアクセスできます。

APIキーの取得方法

管理者としてログインした状態で、Configuration(設定)> System(システム)> APIに移動すると、API v3セクションが表示され、既存のAPIキーの確認や新規追加ができます。API v1セクションにアクセスするには、API v3ヘッダーの下にある「Settings for API v1」リンクをクリックしてください。

これがAPI v1セクションの画面で、API v1キーの設定が行えます。

v3で新しいAPIキーを追加する際、そのキーに対する権限を定義するオプションがあります(複数のキーを持てるため、異なる権限を持つ異なるキーを異なる担当者に付与することも可能です)。

APIキーは変更できますか?

はい、どちらのAPIバージョンにも新しいキーを生成して既存のキーを無効化するオプションがあります。

重要な注意事項: LiveAgentの新しいAPIキーを生成すると、古いキーを使用しているすべてのクライアントが即座に動作しなくなります。この点を忘れないでください!

API v3の使用方法

APIキーはリクエストのヘッダーに設定する必要があります:

curl –location –request GET ‘https://your.ladesk.com/api/v3/tickets'
–header ‘apikey: 0865evv883j6auflvlt7zrwgqn32qo74’
–header ‘Content-Type: application/json’

PHPでのcURLコードの例:

curl_setopt($curl, CURLOPT_HTTPHEADER, array('Accept: application/json', 'apikey: 123456_YOUR_API_KEY_123456'));