Skip to main content

FDK Client Javascript

You are reading an outdated document

Get the latest developer guides on Fynd Partners Help

Getting Started

Let's get started with the Javascript Development SDK for Fynd Platform.

Usage

npm install fdk-client-javascript --save

Using this method, you can require fdk-client-javascript like so:

const {
ApplicationConfig,
ApplicationClient,
} = require("fdk-client-javascript");

Sample Usage - ApplicationClient

const config = new ApplicationConfig({
applicationID: "YOUR_APPLICATION_ID",
applicationToken: "YOUR_APPLICATION_TOKEN",
});

const applicationClient = new ApplicationClient(config);

async function getProductDetails() {
try {
const product = await applicationClient.catalog.getProductDetailBySlug({
slug: "product-slug"
});
console.log(product.name);
} catch (err) {
console.log(err);
}
}

getProductDetails();

Sample Usage - PlatformClient

const { PlatformConfig, PlatformClient } = require("fdk-client-javascript");

let platformConfig = new PlatformConfig({
companyId: "COMPANY_ID",
apiKey: "API_KEY",
apiSecret: "API_SECRET",
domain: "DOMAIN",
});

async function getData() {
try {
// TODO: get token using OAuth
platformConfig.oauthClient.setToken(token.access_token);
const client = new PlatformClient(platformConfig);

// API's without application_id
const tickets = await client.lead.getTickets();
console.log("tickets", tickets);

// API's with application_id
const customers = await client
.application("APPLICATION_ID")
.user.getCustomers();
console.log("customers", customers);
} catch (err) {
console.log(err);
}
}

getData();

TypeScript

fdk-client-javascript includes Typescript definitions.

import { ApplicationConfig, ApplicationClient } from "fdk-client-javascript";

Documentation