Knack Object API

Overview

The Knack Object API is designed for making object-based requests to the Knack platform. If you need view-based requests, please use our other npm package, knack-api.

The Knack Object API provides server-side support for all CRUD operations (GET, POST, PUT, DELETE). It is designed to be recursive upon failure and allows you to specify the data you want to request or modify using function parameters. This package is compatible with both JavaScript and TypeScript.

To use TypeScript, import the necessary interfaces and types from the 'knack-object-api' package.

You will need to create a .env file and set your Knack application ID and API Key as follows: KNACK_APP_ID= KNACK_API_KEY=

Installation

Install the 'knack-object-api' package using npm:

npm install knack-object-api --save

Usage

Once installed, you can import the required functions and interfaces in your code. For TypeScript, use type imports to access interfaces.

const { get, put, post, deletion } = require('knack-object-api');

// For TypeScript type imports const { get, put, post, deletion } = require('knack-object-api'); import { getSettings, putSettings, postSettings, deleteSettings } from 'knack-object-api';

The 'settings' object contains parameters to configure your requests. Here are some of the available options:

objectKey: The Knack object key. page: Optional, used for pagination. recordId: Optional, used for specifying a specific record ID. payload: Optional, contains data for POST requests. filters: Optional, defines filtering rules. sort: Optional, specifies sorting options. rowsPerPage: Optional, limits the number of records per page. debug: Optional, enables debugging (logs request URLs). attempts: Optional, specifies the number of retry attempts in case of failure. recordLimit: Optional, limits the number of records to retrieve. format: Optional, used for formatting the returned fields (options: "html", "raw", or "both").

const settings = { objectKey: 'object_xx', // Other optional parameters }

await get(settings);

Contact

For any inquiries, please visit ksensetech.com.