Skip to main content

API resources

The iGrafx Process360 LiveProcess360 Live iGrafx's cloud platform for end-to-end process management — combining process design, mining, simulation, and automation in a single environment. REST API lets you work with the platform from your own code — read and write repository objects, run reports, manage users, and more. It's available on both cloud and on-premises, and it has been part of the platform since version 16.2.

Overview​

A REST API lets one program work with another over the web. Your code sends an HTTP request to a URL that identifies what you want — a repository object, a report, a user — and the API sends back the answer as JSON, much the way a browser requests a page. The HTTP method says what to do with it: GET reads, POST creates, PUT updates, DELETE removes. Each request carries its own authentication, so there's no session to open or hold open.

Requests go to paths under /api (for example, GET /api/info/version). Each call is authenticated as a platform user, and the API enforces that user's permissions and licenses — so an integration can only do what the user behind it is allowed to do.

The API is turned off by default. An administrator enables it and grants the right permissions before any integration can connect. See Access the REST API.

Callers authenticate with an API key — a per-user key sent in the X-AUTH-APIKEY request header. The key carries all of that user's permissions, so treat it like a password, and run the platform over HTTPS so the key isn't exposed in transit.

note

These pages cover the iGrafx REST API itself: its endpoints, how callers authenticate, and what stays compatible between releases. They don't teach REST or HTTP as such — for those fundamentals, use the general material available online. For guided iGrafx training, see the course catalog at iGrafx University.

Where to find the API documentation​

The endpoint-by-endpoint documentation is generated from the API itself, so it always matches your version:

  • Cloud (SaaS): the hosted reference at https://api.igrafx.com.
  • Cloud and on-premises: the embedded documentation inside the product, at Admin → Support → REST API (the iGrafx Platform API Documentation link). It lets you test endpoints in place. Viewing it requires the Access Support Features server permission.

Cloud and on-premises​

The REST API works the same way on both, but not every endpoint exists on both. Where a capability is cloud-only, so are the endpoints behind it — diagram rendering and narrative downloads, for example, run as cloud-side jobs and aren't served on-premises. See Download diagrams and narratives.

Licensing also differs: cloud instances include a free API tier (a capped number of calls per month) when no API license is present, and the REST API page shows when this applies. On-premises, the API requires the corresponding license.

Related tasks & references​

API guides: