Claris FileMaker搭載のAPIについての備忘録
- 田中
- 3 日前
- 読了時間: 4分
こんにちは、ティーマネジメントの田中です。
FileMaker Server / Cloud で使用できるAPIについて、なんとなくはわかるけど、
ヘルプを読んでもよく分からない、
実際使うとなるとどうすればいいのか…と悩んだ経験がありました。
FileMaker Pro / Go から、FileMaker Server / Cloud のAPIを利用する方法について、
いろいろ試行錯誤した結果、なんとかやりたいことは行えるようになりましたので、
記事として残したいと思います。
そもそもAPIとは？
API（Application Programming Interface）は、異なるソフトウェア同士がやりとりするための窓口のような役割です。FileMakerのAPIを使うことで、外部のアプリやWebサービスとデータをやりとりしたり、自動化したりすることが可能です。
FileMaker Server / Cloud 搭載のAPIの種類
名称 | 用途 | 利用シーン |
FileMaker Data API | HTTPリクエストでJSONデータをやりとり | Webアプリ・モバイル連携、外部システム連携 |
FileMaker Admin API | サーバー管理専用API。サーバー状態やスケジュール管理 | サーバー自動監視、運用自動化 |
FileMaker OData API | BIツールや外部分析ツールと連携 | データ分析、外部レポート作成 |
RESTという仕組みを使ったAPIで、HTTPリクエストでデータの取得、登録、更新、削除が可能です。
データのやり取りにはJSON形式を用います。
FileMakerには主に3つのAPIが搭載されており、それぞれ用途が異なります。
Claris ヘルプセンターにはそれぞれのAPIについてのガイドが用意されています。
FileMaker Server / Cloudをインストール、契約している場合、API仕様書を閲覧できます。
メモ FileMaker Data API Reference を表示するには Admin Console で FileMaker Data API アクセスが有効に設定されていることを確認します。FileMaker Server ヘルプの「FileMaker Data API 設定」または FileMaker Cloud ヘルプの「FileMaker Data API 設定の変更」を参照してください。 |
FileMaker Cloud FileMaker Cloud ホスト上でリファレンスファイルを表示するには、ブラウザを開いて次の URL を入力します。 https://<ホスト>/fmi/data/apidoc/ <ホスト> は FileMaker Cloud ホストの IP アドレスまたはホスト名です。 |
FileMaker Server FileMaker Server のプライマリマシン上でリファレンスファイルを表示するには、ブラウザを開いて次の URL を入力します。 https://localhost:3000/fmi/data/apidoc/ リモートマシン上でリファレンス情報を表示するには、ブラウザを開いて次の URL を入力します。 https://<ホスト>:3000/fmi/data/apidoc/ <ホスト> は FileMaker Server が実行されているプライマリマシンの IP アドレスまたはホスト名です。 Windows: リファレンスファイルは次のフォルダ内にあります。 [ドライブ]:¥Program Files¥FileMaker¥FileMaker Server¥Documentation¥Data API Documentation [ドライブ] は FileMaker Server 展開が存在するドライブです。 Windows 上のデフォルト以外の場所にインストールした場合、次のようにデフォルトのインストールパスの先頭部分がインストール場所に置き換わります。 [ドライブ]:[インストール場所]¥FileMaker¥FileMaker Server¥Documentation¥Data API Documentation macOS: リファレンスファイルは次のフォルダ内にあります。 /ライブラリ/FileMaker Server/Documentation/Data API Documentation Linux: リファレンスファイルは次のフォルダ内にあります。 /opt/FileMaker/FileMaker Server/Documentation/Data API Documentation |
FileMaker Data API
Data APIは、主にFileMaker Server / Cloudで共有されているカスタムAppのデータの取得や更新、削除などに使用されます。
できることの例
・顧客情報の取得や検索
・新しい注文データの登録
・既存データの更新や削除
・FileMakerスクリプトの実行
FileMaker Admin API
Admin APIは、主にFileMaker Server / Cloud上の管理情報などを参照する際に用います。
主な用途
・サーバーのメタデータ（時刻など）の取得
・サーバーの稼働状況チェック
・定期バックアップやメンテナンスの自動化
・管理業務の効率化
FileMaker OData API
OData APIはData APIと似た使い方ができますが、Data APIと異なり、レイアウトに依存せず直接テーブルを参照することが可能です。
主な用途
・Power BIやTableauなどのBIツールでFileMakerのデータを分析
・外部のレポート作成やダッシュボード連携
やりたかったこと
ローカル環境（インターネット接続あり）のFileMaker Pro / Go から、
・FileMaker Serverのメタデータ取得し、サーバー現在時刻を取得する
・FileMaker Serverで共有されているカスタムAppのレコードを更新する
メタデータの取得はFileMaker Admin APIで、
レコードの更新はFileMaker Data APIを用いて行うことにしました。
次回以降の記事で、それぞれの実装方法についてご紹介します。
