@mindfiredigital/fmdapi-node-weaver

fmdapi-node-weaver

Simplify the integration of FileMaker databases with any frontend

The @mindfiredigital/fmdapi-node-weaver is a tool that allows developers to integrate multi page document editors built on top of Canvas using React.

NOTE: : The endpoints shown in figure are for demo purpose, these are not actual endpoints. For actual Data API endpoint, refer documentation

Table of Contents

• Features
• Installation
• Getting Started
• Contributing
• License

Features

• No Mandatory Session Token: Unlike the standard FileMaker Data API, the Bundler does not require a validated session token for every API call. It handles authentication using Basic Auth, generating a new session token if one is not provided or if the session has expired.

• Uniform API Endpoints: Each API endpoint in the Bundler follows a consistent style, simplifying usage and reducing confusion. Regardless of the specific API functionality, you'll find a consistent method structure.

• Automatic Session Management: Users don't need to worry about re-validating their session each time they interact with the API. The Bundler automatically manages sessions by using Basic Auth as an authentication header.

Installation

To install the @mindfiredigital/fmdapi-node-weaver npm package in your project, use the following command:

npm install @mindfiredigital/fmdapi-node-weaver

• Initialization: Initialize the fmdapi-node-weaver in your project, specifying the function.

const fm = require("fmdapi-node-weaver");

const PORT = 9000;

fm.run(PORT);

//If PORT is not specified, it will run on default port 8000

Installation (Without using NPM)

To download the project @mindfiredigital/fmdapi-node-weaver into your system, use the following command:

git clone https://github.com/mindfiredigital/fmdapi-node-weaver

Getting Started

• Initialization: Install the dependencies from the package.json:

npm i

or

yarn

• Launch the server

node app.js

Docker Integration

To containerize your application using Docker, follow these steps:

• Build Docker Image: Build the Docker image using the provided Dockerfile:

docker build -t fmdapi-node-weaver .

• Run Docker Container: Run the Docker container, mapping the desired port (e.g., 3000) to the container's port:

docker run -p 3000:3000 fmdapi-node-weaver

API format:

Endpoint - <endpoint>api/dataApi

• eg. http://localhost:8000/api/daApi

Method - POST

Body Format

{
    "fmServer":"<IpAddress>",
    "method":"<methodName>",
    "methodBody":{<method specific body>},
    "session":{
        "token":"<sessionToken>",
        "required":<true/false>
    }
}

Body Examples

• Signin

{
    "fmServer":"<IpAddress>",
    "method":"signin",
    "methodBody":{
        "username":"<Username>",
        "password":"<Password>",
        "database":"<Filemaker_Filename>"
    },
    "session":{
        "token":"<sessionToken>",
        "required":<true/false>
    }

}

• Signout

{
    "fmServer":"<IpAddress>",
    "method":"signout",
    "methodBody":{
        "database":"<Filemaker_Filename>",
    },
    "session":{
        "token":"<sessionToken>",
        "required":"<true/false>"
    }
}

• CreateRecord

{
    "fmServer":"<IpAddress>",
    "method":"createRecord",
    "methodBody":{
        "database":"<Filemaker_Filename>",
        "layout":"<Layout_Name>",
        "record":{
            "Name": "Varun Sharma",
            "Phone": "11111111111",
            "Address":"Newyork"
        }

    },
    "session":{
        "token":"<sessionToken>",
        "required":<true/false>
    }
}

• GetAllRecords

{
    "fmServer": "<IpAddress>",
    "method": "getAllRecords",
    "methodBody": {
        "database": "<Filemaker_Filename>",
        "layout": "<Layout_Name>",
        "offset":"1",
        "limit": 10

    },
    "session": {
        "token": "<sessionToken>",
        "required": <true/false>
    }
}

• FindRecord

{
    "fmServer":"<IpAddress>",
    "method":"findRecord",
    "methodBody":{
        "database":"<Filemaker_Filename>",
        "layout":"<Layout_Name>",
         "offset": 0,
         "limit": 0,
         "layout.response": "string",
        "dataformats":0,
        "query":[
            {"Name": "=Basudev", "Password": "=1234"},
             {"Phone" : "11111111111", "omit" : "false"}
         ],
        "sort":[
             {"fieldName": "CreationTimestamp","sortOrder": "ascend"}
         ],
        "scripts":{
            "script": "<FM_Script1>",
            "script.param": "<Script1_Param>"
             "script.prerequest": "<FM_Script2>",
             "script.prerequest.param": "<Script2_Param>",
             "script.presort": "<FM_Script3>",
             "script.presort.param": "<Script3_Param>"
        },
         "portal": [
             "<PortalName>"
         ]
    },
    "session":{
        "token":"<sessionToken>",
        "required":<true/false>
    }
}

---

• ExecuteScript

{
    "fmServer":"<IpAddress>",
    "method":"executeScript",
    "methodBody":{
        "database":"<Filemaker_Filename>",
        "layout":"<Layout_Name>",
        "script": "<ScriptName>",
        "param":"<ScriptParam>"
    },
    "session":{
        "token":"<sessionToken>",
        "required":<true/false>
    }
}

---

Contributing

We welcome contributions from the community. If you'd like to contribute to the fmdapi-node-weaver npm package, please follow our Contributing Guidelines.

License

Copyright (c) Mindfire Digital llp. All rights reserved.

Licensed under the MIT license.