fmdapi-client

Manage FileMaker Data API sessions and perform CRUD operations with TypeScript.

17|5|Updated Sep 24, 2024
One-click install
npx skills add https://github.com/proofgeist/proofkit --skill fmdapi-client
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fmdapi-client
Source: https://github.com/proofgeist/proofkit/tree/main/packages/fmdapi/skills/fmdapi-client
Command: npx skills add https://github.com/proofgeist/proofkit --skill fmdapi-client

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies and standardizes interactions with the FileMaker Data API, abstracting away the complexities of authentication, session management, and request formatting.

Core Features & Use Cases

  • CRUD Operations: Perform Create, Read, Update, and Delete operations on FileMaker records.
  • Data Fetching: Efficiently retrieve single records, lists, or all records with flexible querying and sorting.
  • Script Execution: Trigger FileMaker scripts directly from your application.
  • Portal Data Access: Seamlessly work with related data in FileMaker portals.
  • Schema Validation: Ensure data integrity with runtime validation against defined schemas.
  • Use Case: Build a web application that displays and allows editing of customer records stored in FileMaker, including their associated order history, all managed through this client.

Quick Start

Use the fmdapi-client skill to find all active customers in the 'Customers' layout.

Frequently Asked Questions about fmdapi-client

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I connect a TypeScript application to the FileMaker Data API?

Use a TypeScript client for the FileMaker Data API to authenticate, manage sessions, and perform CRUD operations. It abstracts request formatting and automatically manages Data API session tokens for streamlined database interactions.

Can I execute FileMaker scripts directly from my web application?

Yes, you can trigger FileMaker scripts directly from your application using the Data API client. It handles script execution alongside standard CRUD operations, allowing you to run database scripts without manual session authentication.

What is the best way to manage FileMaker Data API session tokens in production?

Manage Data API session tokens automatically using configurable token stores provided by the TypeScript client. This approach abstracts session complexities and ensures secure, streamlined token handling for production environments.

How do I access related portal data in FileMaker through the Data API?

Access related portal data by using the TypeScript client's built-in portal data access features. It allows you to seamlessly retrieve and work with related records alongside standard CRUD operations on FileMaker layouts.

Does this FileMaker Data API client support runtime schema validation?

Yes, the FileMaker Data API client supports runtime schema validation to ensure data integrity. It validates data against defined schemas during operations, preventing malformed data from reaching your FileMaker database.

Can I use the OttoFMS adapter as an alternative to direct fetch for FileMaker data operations?

Yes, the TypeScript client supports both direct fetch and OttoFMS adapters for FileMaker data operations. This flexibility allows you to choose the best connection method for your specific deployment environment.