LiLz GaugeではAPIを利用することで外部システムと連携が可能です。
このセクションではAPIの利用開始方法を説明します。
APIの利用を開始する（アクセストークンの発行）
<前提条件>
- LiLz Gaugeのアカウントが作成されていること（LiLz Gaugeのアカウント作成方法）
- LiLz Gaugeにログインをしていること
1. ブラウザに直入力で https://lilz.io/lilzgauge/token へ移動し、トークン生成画面を起動します。
2. 「生成する」ボタンを押し、APIのアクセストークンを取得します。
この生成されたアクセストークンを用いることでAPIが利用可能となります。
※ 現在生成されるトークンには有効期限がございません。
※ POST / lilzgauge / tokenエンドポイントは、httpセッション認証を介してのみアクセスできます。
APIをテストする
APIに関するドキュメントは https://lilz.io/lilzgauge/docs#/ より確認ができます。
また、このドキュメント上でAPIの動作をテストすることができます。
この記事ではGET /lilzgauge/api/users/self エンドポイントを利用したユーザー情報取得のテスト方法を紹介します。
1. APIドキュメントよりGET /lilzgauge/api/users/self を押します。
2. 「Try it out」ボタンを押します。
3. 生成されたアクセストークンをAuthentication-Tokenにペーストし、「EXECUTE」ボタンを押します。
4. Server Responseで200が返却されれば、APIの疎通テストは完了です。
401エラーが返却される場合は、アクセストークン認証に失敗している可能性がありますので、生成されたアクセストークンが正しく貼り付けられているか確認をしてください。
これでLiLz GaugeのAPIが利用できることを確認できました。
今後はAPIを利用した測定結果の取得方法や他システムへのデータ連携手法など、よりコンテンツを充実させて参ります。