REST APIについて#
REST APIは、manaableのUIを使用せずにmanaableデータにアクセスするためのインターフェースを提供します。このREST APIを利用することで、manaableを自由にアプリケーションに統合することができます。必要なのは、このドキュメント内で対象情報(リソース)を見つけ、実行したい操作(検索、作成、更新など)を選び、manaableのエンドポイントにHTTPリクエストを送信するだけです。URI#
URIは、manaable内のリソースを識別するパスです。URIの基本構造は以下の通りです(例外あり):https://[my-domain-name].manaable.com/api/v[X]/[resource]/
[my-domain-name]
は、manaable UIのサブドメインに置き換えてください。[X]
は、使用するAPIのバージョンに置き換えてください。[resource]
は、リソース名と残りのパスに置き換えてください。HTTPメソッド#
REST APIは、標準的なすべてのHTTPリクエストメソッド(GET、POST、PATCH、PUT、DELETE)をサポートしています。ただし、すべてのリソースがすべてのメソッドに対応しているとは限らないことに注意してください。HTTPヘッダー#
api-key
- これは、manaableの管理サイトから取得できるAPIキーで、リクエストの認証に使用されます。Modified at 2024-06-06 15:00:52