Info

This is the conceptual / architecture reference. For the hands-on, step-by-step walkthrough with screenshots and a real sanitised request/response, see the Setup guide. For the admin-panel GUI reference (screenshots, field-by-field), see Connectors, Connector Secrets, Connector Allowlist, and Connector Enablement.

1. This page — the conceptual / architecture reference.
2. Setup guide — the hands-on E2E walkthrough: rollout, allowlist, credentials, the guided builder, publish, execute, and audit.

A Connector is a governed, server-side definition for calling a third-party REST API and mapping its response into a typed shape a CYPEX application can render — an authenticated CYPEX user’s page can show a table backed by a live external API call, next to tables backed by CYPEX’s own PostgreSQL data.

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.