ヘルプの記事
Insomnia の使用方法
TI はすべての API を OpenAPI 資料として提供しており、Insomnia などのツールにこれらをインポートすることができます。Insomnia は、https://insomnia.rest/ から無償でダウンロードできます。
- Insomnia を開きます
- 新しいプロジェクトの作成
- 「CREATE」 (作成) > 「Request collection」 (コレクションを要求) をクリックします
- 「TI OpenAPI」ファイルをインポートします
- 「Mange environments」 (環境を管理) に移動します
- あなたの基本環境で以下の環境変数が定義済みであることを確認します。
{
"base_url": "{{ scheme }}://{{ host }}{{ base_path }}"
}
- ベース環境を更新した後、「transact.ti.com」環境を選択します。
- 「oauth2ClientId」 (oAuth からクライアント ID へ) に対して TI store API キーを上書きし、「oauth2ClientSecret」 (oAuth からクライアント シークレットへ) に対して TI store API シークレットを上書きする形で、これらを更新します。
コード スニペットの使用方法
TI API ポータル内の資料に埋め込まれている OpenAPI 仕様を使用するか、Insomnia ツールを使用する方法で、TI API が対応しているさまざまな開発言語で、コード スニペットを生成することができます。これらのコード スニペットは、貴社の実装で使用できます。
TI API ポータルを使用する方法:
- 希望の API ページに移動します。
- どれか 1 つのメソッド (関数) を展開します。
- 「お試しください」 (try it out) をクリックします。
- 「実行」 (Execute) をクリックします。
- コード スニペットを示すタブ ページが開きます。
Insomnia を使用する方法:
- コレクションを Insomnia にインポートした後、メソッド (関数) を選択し、右隣にある下向き矢印をクリックします。
- 「コードの生成」 (Generate Code) を選択します。