Delete Single:<\/strong> This tab expects an endpoint that, through a DELETE request, allows you to remove a record from the API.<\/li>\n<\/ol>\n\n\n\nFor each of these endpoints, you will need to set their authentication separately. <\/p>\n\n\n\n
In the next steps, we will walk you through the process of setting up your FileMaker Data API for use in Five.<\/p>\n\n\n\n
Step 2: Authorization: Generating a Bearer Token<\/h3>\n\n\n\n We first need to authorize our access to the FileMaker Data API. To do so, have your Basic Auth username and password ready. This can be configured inside of FileMaker. With your username and password ready, follow these steps inside Five to set up your API:<\/p>\n\n\n\n
2.1. Inside the Connection Wizard,<\/strong> click on Read List Mapping.<\/strong> We skip the General<\/strong> section for now and come back to it later.GET<\/strong> to POST.<\/strong>https:\/\/MyFileMakerServer\/fmi\/data\/vLatest\/databases\/[FileName].fmp12\/sessions<\/code><\/p>\n\n\n\n2.4. Next, click on Authorization <\/strong>and select Basic Auth. <\/strong>Fill in your username and password which you have created in FileMaker. Check out the image below to better understand what your screen should look like before clicking Send.<\/strong><\/p>\n\n\n\n
Image 2.1: How to generate a token in Five<\/em><\/figcaption><\/figure>\n<\/div>\n\n\nOnce you click on Send<\/strong>, here is what the expected response should look like. This response will be shown right inside of Five. <\/p>\n\n\n\n<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>"response"<\/span>:{<\/span>1<\/span> <\/span>item<\/span><\/span>\n"token"<\/span>:<\/span>"e96077f0f5f56a8a55f28a3788858cfcd7ad1298af137a3a80b5"<\/span><\/span>\n}<\/span><\/span>\n"messages"<\/span>:[<\/span>1<\/span> <\/span>item<\/span><\/span>\n0<\/span>:<\/span>{<\/span>2<\/span> <\/span>items<\/span><\/span>\n"code"<\/span>:<\/span>"0"<\/span><\/span>\n"message"<\/span>:<\/span>"OK"<\/span><\/span>\n}<\/span><\/span>\n]<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\nIf you receive an error, ensure that your request type (POST)<\/strong>, URL, <\/strong>and basic authentication<\/strong> (username and password) are correct. <\/p>\n\n\n\n2.6. Copy the token.Bearer Token<\/strong>, which is right next to Basic Auth.<\/strong>Token<\/strong> box.<\/p>\n\n\n\nHere is what your screen should look like:<\/p>\n\n\n
\n
Image 2.2: After generating a bearer token, paste it into the Token <\/strong>field.<\/em><\/figcaption><\/figure>\n<\/div>\n\n\nStep 3: Read List Mapping: Setting Up Your GET Request<\/h3>\n\n\n\n We will keep working on the same screen we were just on, i.e. we are continuing in Read List Mapping with the bearer token filled into the token field.<\/strong><\/p>\n\n\n\n3.1. Start by changing the dropdown box that says POST <\/strong>to GET.<\/strong>https:\/\/MyFileMakerServer\/fmi\/data\/vLatest\/databases\/[FileName].fmp12\/layouts\/[LayoutName]\/records<\/code><\/p>\n\n\n\n3.3. Click on Send<\/strong>. The response now contains a list of all records from your layout in JSON format.Field Mapping. <\/strong>Field Mapping shows you how Five understands the data it receives: it maps the fields from your API to field IDs. Make sure you are happy with each field’s data type and display type. Field Mapping<\/strong>, tick the Primary Key <\/strong>box for the field that contains your primary key. In FileMaker, this field is usually called recordId. Note: You need to set the Primary Key for any tab that handles a GET request. <\/p>\n\n\n\nWe have now successfully set up our first endpoint, the GET endpoint and we have checked our field mapping. Onto the next endpoint! <\/p>\n\n\n\n
Step 4: Get a Single Record: Read Single Mapping<\/h3>\n\n\n\n We now continue by setting up the next endpoint: Read Single Mapping. <\/p>\n\n\n\n
4.1. Click on Read Single Mapping.<\/strong>GET.<\/strong> Usually, in FileMaker, the URL looks similar to this:<\/p>\n\n\n\nhttps:\/\/MyFileMakerServer\/fmi\/data\/vLatest\/databases\/[FileName].fmp12\/layouts\/[LayoutName]\/records\/:recordId<\/code><\/p>\n\n\n\nNow, test whether the endpoint works as expected. It supposed to return a single record from your API.<\/p>\n\n\n\n
4.3. Inside Read Single Mapping, <\/strong>click on Authorization <\/strong>and then on Bearer Token. <\/strong>Paste the token you have generated in step 1.5. above.Params<\/strong>.Value <\/strong>field, fill in any integer, such as 1<\/strong>. This will return the first record.Send<\/strong>. <\/p>\n\n\n\nYou should now be able to see your first record (recordId = 1) of your API.<\/p>\n\n\n
\n
Image 4.1.: Setting up and testing the Read Single Mapping<\/strong> connection<\/em><\/figcaption><\/figure>\n<\/div>\n\n\nStep 5: Create Single: Setting Up the POST Request<\/h3>\n\n\n\n We now continue by setting up the next endpoint: Create Single. <\/p>\n\n\n\n
5.1. Click on Create Single.<\/strong>POST.<\/strong> Usually, in FileMaker, the URL looks similar to this:<\/p>\n\n\n\nhttps:\/\/MyFileMakerServer\/fmi\/data\/vLatest\/databases\/[FileName].fmp12\/layouts\/[LayoutName]\/<\/code><\/p>\n\n\n\nStep 6: Update Single: Setting Up the PUT Request<\/h3>\n\n\n\n We now continue by setting up the next endpoint: Create Single. <\/p>\n\n\n\n
6.1. Click on Update Single.<\/strong>PUT.<\/strong> Usually, in FileMaker, the URL looks similar to this:<\/p>\n\n\n\nhttps:\/\/MyFileMakerServer\/fmi\/data\/vLatest\/databases\/[FileName].fmp12\/layouts\/[LayoutName]\/records\/:record<\/span>Id<\/code><\/p>\n\n\n\nStep 7: Delete Single: Setting Up the DELETE Request<\/h3>\n\n\n\n We now continue by setting up the next endpoint: Delete Single. <\/p>\n\n\n\n
7.1. Click on Delete Single.<\/strong>DELETE endpoint.<\/strong> Usually, in FileMaker, the URL looks similar to this:<\/p>\n\n\n\nhttps:\/\/MyFileMakerServer\/fmi\/data\/vLatest\/databases\/[FileName].fmp12\/layouts\/[LayoutName]\/records\/:recordId<\/code><\/p>\n\n\n\nStep 8: Adding Your API as a Data Source<\/h3>\n\n\n\n 8.1. Now, click on General.<\/strong>New <\/strong>from the WebService <\/strong>dropdown.WebService ID<\/strong> and Name<\/strong>.Basic<\/strong> from Authentication Type.<\/strong>username <\/strong>and password<\/strong>, which you have defined for your FileMaker Data API.Token Endpoint <\/strong>from Step 1.3. above.Token Path, <\/strong>fill in “response”.”token”.Tick \u2714\ufe0f<\/strong> icon to save. <\/p>\n\n\n\nHere is what your General <\/strong>tab should look like:<\/p>\n\n\n\n
Image 7.1: Filling in the General settings for the FileMaker Data API<\/em><\/figcaption><\/figure>\n<\/div>\n\n\nDone – we have now successfully added a FileMaker Data API as a data source in Five!<\/p>\n\n\n\n
Expansion: How to Build an App on the FileMaker Data API<\/h2>\n\n\n\n Once you have successfully added the FileMaker Data API as a data source to Five, the API can be used to:<\/p>\n\n\n\n
\nBuild a responsive web application, such as API dashboards, API admin panels, or API CRUD apps.<\/li>\n\n\n\n Create forms, charts, dashboards, or PDF reports on top of it. Five’s Form <\/strong>and Chart Wizards<\/strong> make it extremely quick to build front-end elements for a responsive web application.<\/li>\n\n\n\nGive a wider audience access to part or all of the data stored in your FileMaker database. Five’s fixed monthly pricing per application – without user limits<\/strong> – makes this viable.<\/li>\n\n\n\nPush some of this data into Five’s MySQL database. Once the data from the API is stored inside Five’s database, it can be queried in standard SQL.<\/li>\n\n\n\n Assign CRUD permissions to different user roles to the API.<\/li>\n<\/ol>\n\n\n\nOnce the connection to your API is set up, the possibilities are almost limitless in Five. To get started developing your app, watch this video and learn how to create a form that connects to your API in Five (fast forward to 5 min 25 sec to see how to create a form on an API):<\/p>\n\n\n\n