PlanningPME API

このドキュメントでは、以下についての情報を提供します：

定義と役割：APIとは何か？

APIは、アプリケーションプログラミングインターフェイスです。理解を深めるために、これらの各用語について説明しましょう：

- "Application":アプリケーションは、人間またはコンピュータプログラムがアクセスできるサービスです。
例：Facebookはソーシャルネットワークアプリケーション、Spotifyはオーディオストリーミングアプリケーション、PlanningPMEはプランニングアプリケーションです。
- "Programming"：プログラムは、開発者が自分の代わりにタスクを実行することによって作成された一連のコンピューター機能です。
例：住所を地理座標に変換したい場合は、手動で行うことも、プログラムを作成して自分で行うこともできます。
- "Interface"：インターフェースは、2つのものの間、この場合はアプリケーションとそれを使用するプログラムの間の接続を確立します。これは、プログラムがアプリケーションに何を要求できるかを定義し、プログラム要求をアプリケーションに送信し、アプリケーションの応答をプログラムに送信します。

PlanningPME - API
リモコンが視聴者がテレビをプログラムするために使用するインターフェースであるように、APIはプログラマーがアプリケーションと対話するために使用するインターフェースです。

したがって、PlanningPME APIは、PlanningPMEアプリケーションのインターフェースであり、主要な役割を果たします。
必須の交点として、アクセスの識別、送信の保護、要求の量の制御などが可能です…

PlanningPME APIの各インストールには、APIに対してプログラム（またはプログラムのセット）を認証するAppKeyと呼ばれる保護されたキーを介してアクセスできます。

デフォルトでは、同じAppKeyの最大リクエスト量は1時間あたり2,000です。
この制限を超えると、キーの所有者にオーバーランが通知され、次の料金表に従ってプランが調整されます。

例：私のプログラムは同じAppKeyを使用して1時間以内に4,500件のリクエストを行い、1時間あたりの割り当てが「Micro」スライスに達し、月末に30ユーロが請求されることをメールで通知されます。

1時間あたり10,000リクエストを超える場合は、事前の合意が必須です。
この最大許可使用クォータを超えているキーは、すぐにオフになります。

PlanningPME APIには、2種類の操作があります。

標準API を使用すると、PlanningPMEアプリケーションですべての基本的な単位操作を実行できます。

例：イベントの追加/変更/削除、クライアント/プロジェクト/リソースの更新、グループの権限の変更、オプションの変更など…

これらの操作はすべて、対話型ドキュメントで説明されています。

カスタムAPI を使用すると、PlanningPMEアプリケーションで一括操作を実行でき、統合テンプレート内でこれらの操作を設定できます。

例：25,000人の顧客の更新された情報を1回のリクエストで、事前定義およびカスタマイズされた形式でAPIに送信します。APIは、すでにベースにある顧客の更新、新しい顧客の追加、または廃止された顧客の削除を担当します。

これらの操作は、統合操作（APIの「統合」メソッド）とも呼ばれ、統合テンプレート内で定義されます。

一括同期（たとえば、クライアント/リソース/プロジェクト）を行う場合はキーの使用制限を超えないようにカスタムAPIを実装することを強くお勧めします。カスタムAPIを使用した同期は、クエリで更新されたアイテムの数に関係なく、1つのリクエストのみで済みます。

詳細についてはカスタム統合APIのドキュメントをご覧ください。