API Proxy
OttoFMS exposes proxy access for the FileMaker Data API, FileMaker OData API, and FileMaker Admin API. The proxy allows you to access these FileMaker APIs using long-lived API keys instead of your username and password.
Data API Proxy
Think of a Data API key as a replacement for a set of FileMaker credentials to a specific FileMaker file. It provides access to the FileMaker Data API for that file.
First, create a Data API key (guide). Data API keys are linked to one or more database files and replace the FileMaker credentials for those files. The credentials you enter must have the fmrest privilege set for those files.
Add the following header to your HTTP request:
Authorization: Bearer dk_12395874Or add the following query parameter to your URL:
?apiKey=dk_12395874Prefix the base URL with /otto. For example:
https://filemaker.yourserver.com/otto/fmi/data/vLatestOData API Proxy (OttoFMS 4.11.0)
The OData Proxy also uses Data API Keys, similar to the Data API Proxy. When creating a Data API Key to use for the OData Proxy, you'll need to check the "OData" checkbox. The credentials you enter must have the fmodata privilege set for that file or files.
Add the following header to your HTTP request:
Authorization: Bearer dk_12395874Or add the following query parameter to your URL:
?apiKey=dk_12395874Prefix the base URL with /otto. For example:
https://filemaker.yourserver.com/otto/fmi/odata/v4The OData Proxy does some standardization of the incoming URL to ensure that requests are processed the same no matter where they come from. the primary standardization is that the filename always has the ".fmp12" file extension removed from it.
(Before OttoFMS 4.15.0, the filename was standardized to always include the ".fmp12" file extension.)
Admin API Proxy
Think of an Admin API key as a replacement for your FileMaker Server Admin Console credentials. It provides access to both the FileMaker Admin API and the Otto Developer API.
First, create an Admin API Key (guide).
Add the following header to your HTTP request:
Authorization: Bearer ak_123987Prefix the base URL with /otto. For example:
https://filemaker.yourserver.com/otto/fmi/admin/v2You can also use an Admin API key to authenticate against the Otto Developer API.