7分で読めます
機能
もちろん当社の API は GraphQL に基づいて構築されているため、monday.com アカウントの情報にアクセスし、変更することができます。
なぜ GraphQL なのか？
当社のユーザーは、monday.com を使用してあらゆる種類の情報を管理し、当社のプラットフォームと同じくらい柔軟な API を構築することを望んでいました。そのため、必要なときに必要な情報を正確に取得できるよう、表出的なクエリを処理できる API を構築しました。クエリ言語としての GraphQL に関する詳細は、graphql.orgをご覧ください。😄
ドキュメンテーションとテスト
API を簡単に使用できるように、データに対して実行できるクエリとミューテーションについて説明したドキュメントをこちらに作成しました。こちらの GraphQL エクスプローラーでクエリをテストすることもできます。
API トークンで認証する
API へのリクエストには、お客様本人であることを証明するため、APIトークンを添付する必要があります。😊
管理者ユーザーの API
アカウントの各ドメインは、それぞれ独自の API トークンを持っています。安全に管理してください。API トークンの生成方法：
- monday.com アカウントにログインする。
- 左下にあるアバターをクリックする。
- 管理者を選択。
- 管理者ページ左側にある「API」を選択する。
- ユーザー API トークンの右側にある「コピー」ボタンをクリックします。以下のように表示されます。
管理ユーザー以外の API
monday.com アカウントの管理者でない場合は、開発者セクションから以下のステップに従って API トークンを獲得します。
- 画面左下のプロフィール写真をクリック
- 「開発者」を選択します
- 上部にある「開発者」→「アクセストークン」をクリック
- API トークン横にある「表示」を選択すると、API トークンもコピーすることができます
この API トークンを使って、テスト環境だけでなく、API へのすべてのリクエストを認証することができます。必要に応じていつでもトークンを再生成できます（古いトークンは期限切れになります）。
OAuth を通して生成された API トークン
OAuth 認証 フローを使用して、特定のアプリ用にトークンを生成することもできます。これらのトークンの権限は、リンクされているアプリの認証スコープに基づいて制限されます。詳しくは、OAuth ドキュメンテーションをご覧ください。
API トークンの権限
各ユーザーの API トークンは、そのユーザー自身の権限にスコープされます。
例えば、ユーザーが特定のボードに対して閲覧専用の権限を持っている場合、API トークンはそのボードのいかなる情報も更新することはできません。
同様に、ユーザーがプライベートボードへの権限を持っていない場合、API トークンを使用するアプリも、そのボードにアクセスできません。
GraphQL API へのアクセス
実装する前にテストを希望するユーザーが多いことは把握済みですので、プラットフォームにクエリエディタを直接組み込みました。これを使用して、アプリに実装する前にクエリやミューテーションを試すことができます。 API エクスプローラーを使用するにはこちらのリンクへ移動してください。
エクスプローラーページが開いたら、このフィールドに API トークンを入力します。
トークンを適用すると、テスト環境に入ります。Explorer の左ペインにクエリやミューテーションを入力し、左上の「プレイ」を押すと、右ペインに結果が表示されます。
右上の「Docs」ボタンをクリックすると、エクスプローラーから直接ドキュメントにアクセスすることもできます。エクスプローラー外で当社のドキュメンテーションにアクセスするには、こちらのリンクをご利用ください。
リクエストの送信
クエリのテストが終わったので、アプリから直接クエリを送信したい？お任せください。😊
サーバーへのリクエストはすべて、api.monday.com/v2 に送信される投稿リクエストでなければなりません。
必ず application/json コンテントタイプを使用し、ヘッダーの「認証」パラメーターとして API キーを渡してください。
{
"Content-Type" : "application/json",
"Authorization" : "mySuperSecretAPIKey"
}
リクエスト本文には、クエリと変数が渡すされます。次のように表示されます：
{
"query" : "...",
"variables" : {"myVariable" : "foo", "yourVariable" : "bar"}
}
cURL での簡単な例
これらをまとめると、以下の cURL コマンドを使って、GraphQL API を使用したユーザー名を取得することができます。
curl -X "POST" -H "Content-Type:application/json" -H "Authorization:XXXXX" -d '{"query":"{me{name}}"}' 'https://api.monday.com/v2'
制限事項
API レートの制限は複雑さのレベルに基づいており、1アカウントにつき10,000,000/分までとなっています。詳しくは、 こちらでご確認いただけます。
コーディングを楽しみましょう！
API へのリクエスト送信の基本を理解したところで、こちらのドキュメントをご覧ください。テスト環境はこちらでもご覧いただけます。
最後に、さまざまなプログラミング言語の クイックスタート・チュートリアルをご覧ください。
ご不明な点がございましたら、こちらから担当チームにお問い合わせください。24時間年中無休でお答え致します。
コメント