Skip to main content
CYPEX Documentation
Support
v2.0.0 Latest stable release View changelog ->

REST API

The CYPEX data API is an integral part of the system. Every query is automatically exposed as an API endpoint. The infrastructure honors access privileges and automatically keeps the API up to date.

The general purpose of the API is to allow users to build custom apps which are hard to create with the built-in WYSIWYG editor. In addition, it allows for easier integration with other infrastructure components. It is important to understand in this context that CYPEX is not “all or nothing” — it is perfectly feasible to use only the API.

Read full post

Internal API

Data & Content → Internal API lets you explore and test the CYPEX backend’s own endpoints, rendered from its generated OpenAPI specification.

This screen is System Administrator only (system admin visibility).

Internal API vs REST API

CYPEX exposes two different HTTP surfaces. They are not interchangeable:

REST APIInternal API
What it exposesYour queries (database views), as PostgREST endpointsCYPEX platform endpoints — administration, authentication, connectors, audit
Who it is forApplications and external consumers of your dataPlatform administration
Access controlPostgreSQL grants and Row-Level SecurityBackend authorization; System Administrator only
Where the spec comes fromGenerated by PostgREST from the exposed schemaGenerated from the backend’s OpenAPI specification

If you are integrating an external system with your CYPEX data, use the REST API. The Internal API is an administration and debugging surface.

Read full post

Files

The next big feature of CYPEX we want to focus on is the ability to upload files. Files are stored in the database. Storing files in the database has always been controversial. However, in this case it is done to ensure that all data including the application itself can be saved using standard PostgreSQL backups. There is no need to back up the database, the application, and those files separately — everything is in the same backup. In addition, files are handled in a transparent manner which brings countless advantages if you are dealing with workflows.

Read full post

User Reports

Under Data & Content → User Reports, the admin panel lists every PDF report generated by a CYPEX application — both interactive reports (rendered from a live page view) and static reports (LaTeX-based), as described in PDF Reports:

Reports

Each generated report shows its File name, the Application Name and Role that produced it, and when it was created. Click the download icon to retrieve the PDF.

Each generated report shows its File name, the Application Name and Role that produced it, and when it was created. Click the download icon to retrieve the PDF.

Reports are stored in the database — like Files, this keeps them inside the same PostgreSQL backup as the rest of the application, with no separate file-storage backup to manage. The Role column reflects who generated the report, which is useful when auditing who requested what.

Read full post