Claris FileMaker 19 Admin API ガイド
メモ このドキュメントは FileMaker 19 および Claris 40 製品用で、特に指定がない限り「FileMaker」は両方を意味します。
FileMaker Admin API は、Admin Console ではなくスクリプトを使用することで FileMaker Cloud および FileMaker Server 上での管理タスクを Web サービスから実行できるようにするアプリケーションプログラミングインターフェース (API) です。この API は REST (Representational State Transfer) アーキテクチャを使用しているため、 Admin API は REST API です。
Admin API は、特定のプログラミング言語形式に依存しないことから REST API で一般的に使用されているテキスト形式 JSON (JavaScript Object Notation) でデータを返します。
Admin API を使用するには:
-
Admin API 呼び出しを使用して管理タスクを実行するコードを作成します。
-
Admin API アクセスが正しく動作するかをテストします。
-
FileMaker Cloud の「gateway.log」ファイル、FileMaker Cloud のアップロードおよび更新 API 呼び出しの「event.log」ファイル、または FileMaker Server の「fac.log」ファイルを確認して結果を監視します。「gateway.log」、「event.log」、および「fac.log」ファイルは Admin Console からダウンロードすることができます。Claris Server および FileMaker Server ヘルプを参照してください。
メモ 共有データベースのデータにアクセスするには、Claris Data API および FileMaker Data API ガイドを参照してください。
このガイドについて
このガイドでは、FileMaker Admin API バージョン 2 (v2) を使用して FileMaker Cloud および FileMaker Server 上で管理タスクを実行する方法について説明します。(FileMaker Admin API バージョン 1 (v1) については、サポートされている製品にインストールされる FileMaker Admin API Reference を参照してください。)
このガイドでは、次の経験があることを想定しています:
-
FileMaker Pro を使用したデータベースのアップロード。Claris Pro および FileMaker Pro ヘルプを参照してください。
-
FileMaker Server または FileMaker Cloud を使用したデータベースの共有および管理。Claris Server および FileMaker Server ヘルプまたは FileMaker Cloud ヘルプを参照してください。
-
POST、GET、PATCH、PUT、および DELETE メソッドと JSON 形式のデータを呼び出すサーバーサイドアプリケーションまたは Web サービスでの REST API の使用。任意のプログラミング言語またはプログラミングツールを使用できる必要があります。
メモ
-
「FileMaker Cloud」は FileMaker Pro、FileMaker Go、および FileMaker WebDirect を使用するカスタム App をクラウド上で使用するためのサービスです。FileMaker Cloud では Claris ID と統合されたサインオンシステムを使用してユーザを認証し、Claris International Inc. から直接提供されます。
-
このガイドでは「Admin Console」は特定の製品について説明する場合以外、FileMaker Server および FileMaker Cloud の Admin Console を意味します。
-
「カスタム App」、「ソリューション」、「データベース」、および「ファイル」は FileMaker 製品を使用して作成および操作するものを意味します。
-
このガイドでは「アクセストークン」は認証に必要な JSON Web Token を意味します。