Menu

Samenvatting van de Efficy API

De Efficy API stelt je in staat om CRM-data te integreren met externe systemen, maar werkt anders dan klassieke REST APIs. Alle operaties lopen via JSON-RPC-aanroepen of via web-requests met een functie-naam in de body. Efficy-integraties worden typisch gebouwd met de community-onderhouden Node.js-SDK of via directe SOAP/JSON-calls.
  • Consult en search: Haal entiteiten op (Company, Contact, Opportunity, Project, Document, Action, Task) via de /consult- en /search-endpoints met JSON-RPC-bodies of via de CrmRpc.search-methode van de SDK.
  • Edit en insert: Maak of wijzig entiteiten via de /edit-endpoint of via openEditObject, updateField en commitChanges in de SDK. Bulk-bewerkingen via executeBatch.
  • Relaties beheren: Koppel entiteiten met /addrelation of setReference, updateReciprocityField (medewerker ↔ contact, contact ↔ bedrijf, etc.).
  • Queries en rapportages: Voer systeem- en database-queries uit via /runquery of executeDatabaseQuery, executeSqlQuery, executeSystemQuery voor custom rapportages.
  • Attachments en images: Beheer documenten en afbeeldingen via /img, insertAttachment, updateAttachment en getAttachment (AttachmentObject).
  • Guest access en dialog: Beperkte read-only-toegang via /guest voor externe portals; dialogen voor custom workflow-interacties via /dialog.
API Quick Facts Overig
  • Authenticatie API Key
  • Methods POST (8)
  • Rate limits Niet gespecificeerd
  • Webhooks Niet beschikbaar
  • Sandbox Beschikbaar
  • Response format JSON, XML
  • SDK's Node.js

Laatste ontwikkelingen bij de Efficy API

Efficy is in 2000 opgericht en heeft haar API-model incrementeel uitgebreid van SOAP en XML-RPC naar JSON-RPC met een universele web-request-architectuur. Alle integraties gebruiken één POST-endpoint per type bewerking (/consult, /edit, /search, /addrelation, /runquery, /img, /guest, /dialog) waarbij de entity-type en parameters in de request-body staan. Dit past niet in een klassieke REST-endpoint-catalog maar maakt de API wel zeer flexibel voor custom entity-modellen. De community-onderhouden `efficy-enterprise-api` NPM-package (Pauwris) biedt een moderne Node.js-SDK met 40+ high-level methodes die onder water JSON-RPC-calls doen. Officiële documentatie staat op help.efficy.io/edn/api (MadCap Flare SPA).

API versies

efficy 12.1 Major release
1 januari 2024

Meest recente versie van het efficy Enterprise platform met uitgebreide JSON-RPC-functies, verbeterde workflow-integratie en nieuwe template-tags voor custom dashboards.

efficy 12 (2021) Major release
1 januari 2021

Grote versie-bump met hernieuwde integratie-architectuur: unified web-requests, consistente JSON/SOAP-request-naming en uitgebreide serverscripting-mogelijkheden.

Community Node.js SDK

Release van de community-onderhouden efficy-enterprise-api NPM-package (Pauwris) met class-based wrapper rond JSON-RPC: CrmRpc, CrmEnv, ConsultObject, EditObject, DataSetObject, etc.