Integrate an External System
You have a system of your own — a storefront, a warehouse tool, a marketplace connector, a data warehouse — and you need it to exchange data with BigLedger. This section is the path from nothing to moving real records.
What the integration surface is
BigLedger has one REST API, served over HTTPS, returning JSON. Every path is built the same way:
/core2/{tnt|platform}/{dm|ms}/<module>/<resource>/<access-endpoint>The last segment is the access endpoint, and it says which category of caller an endpoint is
built for — backoffice-ep for a staff user in the BigLedger shell, login-ep and
login-entity-ep for signed-in users acting on their own records, public-ep where a resource is
deliberately open, and etl-ep for server-to-server integrations. That last one is your
surface.
It is not a narrow surface. Around 950 endpoint methods across 156 controllers carry the
etl-ep variant, covering roughly 287 resources — customers and suppliers, items and
inventory, companies, branches and locations, pricing, labels, stock take, membership, contacts,
payment gateways, and every business document type through one generic document endpoint.
Each resource exposes the same six operations:
POST | …/etl-ep — create |
PUT | …/etl-ep — update |
DELETE | …/etl-ep/{guid} — delete |
GET | …/etl-ep — list |
GET | …/etl-ep/{guid} — read one |
GET | …/etl-ep/query — filter and paginate |
So the answer to push or pull is both, over the same endpoints, plus an outbound event path via webhooks.
What you need before you start
Three things, and only one of them is self-service.
| Self-service? | |
|---|---|
| A tenant code — the customer database you are integrating with | No. It comes from BigLedger or from the customer. |
| A user account in that tenant, with the right permissions | No. A tenant administrator creates it and grants the permissions. |
| An access key for that user | Yes. One API call. See Getting Started. |
An access key carries the permissions of the user it belongs to and nothing else — there is no per-key scope. That makes the second row the one that decides what your integration can do, so settle it before you write code.
What BigLedger does not give you
Stated plainly, so you can plan around it rather than search for it.
blg-akaun-ts-lib, blg-akaun-ng-lib) are Angular libraries for applets running inside the
BigLedger shell; they do not target the server-to-server endpoints. The Java client library is
published to a private repository. You write HTTP yourself — which is not onerous, because
every resource has the same six-method shape.429, or enforces a quota. Requests stream and can run long. Pace your own jobs — see the
limits in the Data API.Where to ask
When one of the hand-offs above is what stands between you and a working integration, the contact is developers@bigledger.com. Say which tenant, which resources you need to read or write, and in which direction. The three things worth asking for by name are a test tenant, an integration user with a named permission set, and — if you need a resource that is not documented here — the current route for it.