Claris FileMaker 19 Data API Guide

Note  This document is for FileMaker 19 and Claris 40 products and uses “FileMaker” to refer to both, unless otherwise specified.

The FileMaker Data API is an application programming interface (API) that allows web services to access databases hosted by FileMaker Server or FileMaker Cloud. Because this API conforms to Representational State Transfer (REST) architecture, the FileMaker Data API is a REST API.

Your web service or application calls the FileMaker Data API to obtain an authentication token for access to a hosted database, then uses that token in subsequent calls to create records, update records, delete records, and perform find requests.

The FileMaker Data API returns data in JavaScript Object Notation (JSON), a text format that is commonly used with REST APIs because it is independent of specific programming language formats.

This guide assumes you are experienced with:

  • using FileMaker Pro to create databases. You should understand the basics of FileMaker Pro database design and the concepts of fields, relationships, layouts, portals, and containers. See Claris Pro and FileMaker Pro Help.

  • using FileMaker Server or FileMaker Cloud to host databases. You should understand how to set up the host, enable access to hosted databases, and monitor hosted databases using Admin Console.

  • using REST APIs in server-side applications or web services that call POST, GET, PATCH, and DELETE methods with data in JSON format. You can use any programming languages or tools you choose.

This guide uses Admin Console to refer to Admin Console for FileMaker Server and FileMaker Cloud, unless describing a particular product.

To use the FileMaker Data API, follow these steps:

  1. Prepare your database for FileMaker Data API access using FileMaker Pro. You can create a database or prepare an existing database. See Prepare databases for FileMaker Data API access.

  2. Write code that calls FileMaker Data API methods to find, create, edit, duplicate, and delete records in a hosted database. See Write FileMaker Data API calls.

  3. Host your solution with FileMaker Data API access enabled. See Host a FileMaker Data API solution.

  4. Test that FileMaker Data API access is working correctly. See Test the FileMaker Data API solution.

  5. Monitor your hosted solution using Admin Console. See Monitor FileMaker Data API solutions.