FDK Extension Helper Library
const bodyParser = require("body-parser");
const express = require("express");
const cookieParser = require("cookie-parser");
const { setupFdk } = require("fdk-extension-javascript/express");
const { RedisStorage } = require("fdk-extension-javascript/express/storage");
const Redis = require("ioredis");
const app = express();
app.use(cookieParser("ext.session"));
app.use(bodyParser.json({ limit: "2mb" }));
const redis = new Redis();
let extensionHandler = {
auth: async function (data) {
console.log("called auth callback");
},
uninstall: async function (data) {
console.log("called uninstall callback");
},
};
let fdkClient = setupFdk({
api_key: "<API_KEY>",
api_secret: "<API_SECRET>",
base_url: baseUrl, // this is optional
scopes: ["company/products"], // this is optional
callbacks: extensionHandler,
storage: new RedisStorage(redis),
access_mode: "offline",
});
app.use(fdkClient.fdkHandler);
app.listen(8080);To call platform api you need to have instance of PlatformClient. Instance holds methods for SDK classes. All routes registered under platformApiRoutes express router will have platformClient under request object which is instance of PlatformClient.
Here
platformApiRouteshas middleware attached which allows passing such request which are called after launching extension under any company.
fdkClient.platformApiRoutes.get("/test/routes", async (req, res, next) => {
try {
let data = await req.platformClient.lead.getTickets();
res.json(data);
} catch (error) {
console.error(error);
next(error);
}
});
app.use(fdkClient.platformApiRoutes);Background tasks running under some consumer or webhook or under any queue can get platform client via method getPlatformClient. It will return instance of PlatformClient as well.
Here FdkClient
access_modeshould be offline. Cause such client can only access PlatformClient in background task.
function backgroundHandler(companyId) {
try {
const platformClient = await fdkExtension.getPlatformClient(companyId);
let data = await platformClient.lead.getTickets();
// Some business logic here
res.json({ success: true });
} catch (err) {
console.error(err);
res.status(404).json({ success: false });
}
}To call partner api you need to have instance of PartnerClient. Instance holds methods for SDK classes. All routes registered under partnerApiRoutes express router will have partnerClient under request object which is instance of PartnerClient.
Here
partnerApiRouteshas middleware attached which allows passing such request which are called after launching extension under any company.
fdkClient.partnerApiRoutes.get("/test/routes", async (req, res, next) => {
try {
let data = await req.partnerClient.lead.getTickets();
res.json(data);
} catch (error) {
console.error(error);
next(error);
}
});
app.use(fdkClient.partnerApiRoutes);Webhook events can be helpful to handle tasks when certan events occur on platform. You can subscribe to such events by passing webhook_config in setupFdk function.
let fdkClient = setupFdk({
api_key: "<API_KEY>",
api_secret: "<API_SECRET>",
base_url: baseUrl, // this is optional
scopes: ["company/products"], // this is optional
callbacks: extensionHandler,
storage: new RedisStorage(redis),
access_mode: "offline",
webhook_config: {
api_path: "/api/v1/webhooks", // required
notification_email: "test@abc.com", // required
subscribe_on_install: false, //optional. Default true
subscribed_saleschannel: 'specific', //optional. Default all
event_map: { // required
'company/brand/create': {
version: '1',
handler: handleBrandCreate
},
'company/location/update': {
version: '1',
handler: handleLocationUpdate
},
'application/coupon/create': {
version: '1',
handler: handleCouponCreate
}
}
},
debug: true // optional. Enables debug logs if `true`. Default `false`
});By default all webhook events all subscribed for all companies whenever they are installed. To disable this behavior set
subscribe_on_installtofalse. Ifsubscribe_on_installis set to false, you need to manually enable webhook event subscription by callingsyncEventsmethod ofwebhookRegistry
There should be view on given api path to receive webhook call. It should be POST api path. Api view should call processWebhook method of webhookRegistry object available under fdkClient here.
Here
processWebhookwill do payload validation with signature and calls individual handlers for event passed with webhook config.
app.post('/api/v1/webhooks', async (req, res, next) => {
try {
await fdkClient.webhookRegistry.processWebhook(req);
return res.status(200).json({"success": true});
}
catch(err) {
logger.error(err);
return res.status(500).json({"success": false});
}
});Setting
subscribed_saleschannelas "specific" means, you will have to manually subscribe saleschannel level event for individual saleschannel. Default value here is "all" and event will be subscribed for all sales channels. For enabling events manually use functionenableSalesChannelWebhook. To disable receiving events for a saleschannel use functiondisableSalesChannelWebhook.
After webhook config is passed to setupFdk whenever extension is launched to any of companies where extension is installed or to be installed, webhook config data is used to create webhook subscriber on Fynd Platform for that company.
Any update to webhook config will not automatically update subscriber data on Fynd Platform for a company until extension is opened atleast once after the update.
Other way to update webhook config manually for a company is to call syncEvents function of webhookRegistery.