Tulip APIドキュメントとは、TulipのAPIに関して利用方法や機能等を説明した文書です。
本記事ではその利用方法について説明します。
APIとは
APIとは「Application Programming Interface」の略で、異なるシステムやソフトウェア間で機能やデータをやり取りするためのインターフェイスのことです。他のシステムやクラウドサービス等と接続する場合に利用します。
TULIPにおけるAPIを「Tulip API」、Tulip APIに関して説明した文書を「Tulip APIドキュメント」と呼びます。
Tulip APIドキュメントの利用方法
利用における前提条件
Tulip APIを利用するには、APIキーを発行する必要があるため、アカウント所有者の権限が必要です。
App Editor画面右上のユーザーアイコンマークをクリックすると、どの権限が付与されているかが確認できます。
アクセス方法
- App Editor画面右上のユーザーアイコンマークより、設定を開く
- 左のメニューよりAPIトークンをクリックし、右上の「さらに詳しく」を開く
- Tulip APIドキュメントが開く
ドキュメントの見方
上部にあるserversはAPIサーバーのURLで、APIにアクセスするための具体的な接続先を示しています。
Tulip APIでは下記の5つの主要なHTTPメソッドが使用でき、各項目における利用可能なHTTPメソッドが記載されています。
HTTPメソッドとは、サーバーに対して「何をしたいか」を伝えるための命令の種類を指します。
- GET：データを取得する
- POST：新しいデータ作成する
- DELETE：データを削除する
- PUT：データを全体的に更新する
- PATCH：データの一部を更新する
HTTPメソッドの右横にはエンドポイント、機能の説明が記載されています。
下記例では、テーブルの集計一覧を取得します。
エンドポイントとは、特定の機能やデータにアクセスするための個別のURLを指します。
HTTPメソッドを開くと、Parameters・Responsesが表示されます。
Parametersはどのデータを取得したいか、どのような条件で絞り込みたいか、どのように処理してほしいかを伝えるための情報(*マークは必須項目)です。
必要なパラメータを設定し、リクエストを送信します。
ResponsesはAPIに送ったリクエストに対する結果を表します。
下記の応答コードと、JSON形式のコードが返ってきます。
- 200：成功
- 400：エラー（リクエストの構文エラー）
- 401：エラー（リクエストが許可されていない）
- 403：エラー（認証情報が拒否されている）
- 404：エラー（要求されたデータが見つからない）
- 422：エラー（リクエストに対しサーバが処理できない）
- 500：エラー（サーバーの予期せぬエラー）
APIトークンの作成方法
APIを利用するには、APIトークンを発行する必要があります。
APIトークンとは、誰がリクエストを送っているかを識別し、アクセス権を管理するための言わばAPIを使うためのパスワードです。
APIトークンの作成方法はリンクの記事をご確認ください。APIトークンを作成し、Tulip APIを使えるようにする
Tulip APIドキュメント上でのテスト方法
Tulip APIドキュメント上でリクエストをテストすることができます。
リンクの記事に記載していますので、ご確認ください。テーブルレコードの一括削除
なおテストとはいえ実際に実行されるため、注意が必要です。