API & integration

Connect external systems through VFlowPro’s documented Entity API.

Use VFlowPro’s documented REST API to read or write registered entity data where the schema permits it. Start with the published documentation, authenticate data operations with a bearer token, and build only against the routes the API exposes.

See how the API works
Bearer authenticationRegistered entitiesOpenAPI 3.0Schema discovery
VFlowPro Entity APIAuthenticated data request
GET /api/v1/entity/productsAuthorization: Bearer ••••••••# Registered entity route — bearer token required{ "product": "VF-2408", "status": "active" }
A defined integration surface

Know exactly what you can connect before you build.

The API provides public documentation and OpenAPI material, with authenticated discovery for registered entities. Your implementation team can check available data and permitted operations before it writes code.

Start with the documentationUse public API documentation, OpenAPI material and authenticated discovery to understand what is available.
Authenticate data accessUse bearer-token authentication when an external system reads or writes supported entity data.
Confirm available operationsUse schema-enabled entity CRUD where the API exposes it, rather than assuming every workflow has an endpoint.
Understand the interface

Confirm the data model before you build.

Documentation and discovery routes help a developer confirm supported entities, their schemas and the available operations before building against the API.

Read the public API documentationBegin with the documented REST interface and OpenAPI material.
Discover supported entitiesUse authenticated introspection to examine the enabled entity-data routes.
Review the schemaUse the supported entity schema before deciding how data should be read or written.
Authenticate data access

Use authenticated access for entity data.

Bearer-token authentication is the access mechanism for entity data operations. The interface exposes CRUD only where the registered entity schema permits it.

Authenticate with a tokenUse bearer-token access for entity data operations rather than a shared application session.
Work with registered entitiesUse the enabled entity routes exposed by the interface.
Use supported operationsRead, create, update or delete only where the relevant entity schema permits it.
A purposeful integration surface

A focused API for registered entity data.

The API is deliberately limited to registered entity data and the operations their schemas permit. That gives external systems a defined surface to work against.

VFlowPro’s API is intentionally bounded to the supported entity-data workflows it exposes. It does not claim that every portal action or business process is available through an endpoint.

  • Use supported entity routesBuild against the documented entities and schemas available through the authenticated interface.
  • Authenticate data operationsUse bearer-token authentication for supported entity data access.
  • Give developers a clearer startPublic OpenAPI material and API documentation provide a shared point of reference for supported work.