Efficy Enterprise API

Introduction

The Efficy Enterprise API is developed for server-side usage in a Node.js environment (e.g. for integrations) and also bundled for usage inside an Efficy browser session for client-side JSON RPC requests.

Node.js instructions

In your Node.js project, first install the efficy-enterprise-api npm package.

powershell

npm i efficy-enterprise-api

import { CrmEnv, CrmRpc} from "efficy-enterprise-api";

const crm = new CrmRpc(crmEnv); // See CrmEnv class
const compSearch = crm.search("comp", "SEARCHFAST", "Efficy");
await crm.executeBatch();

// Debug output
compSearch.items; // An array of row items

Efficy in browser instructions

Switch and use the efficy-enterprise-api-browser npm package. Consider reading this Efficy Project Guide about using the Efficy Enterprise API - for browser.

Get started

Consult the github-pages documentation

(2022) authored by Kristof Pauwels