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.

The purpose of the REST API section is to give users a Swagger-style method to test the API generated by CYPEX. Endpoints are grouped by table/view, one entry per HTTP verb (GET/POST/PATCH/DELETE), and available to users with the appropriate role after authentication:

REST API

Endpoints are grouped by table. Use Filter by tag to narrow the list, or Refresh API Schema after adding a new query.

Expand any endpoint to fill in its parameters and click Execute to send a real request using your current session. The response — status code, body, and headers — is shown right below:

Executed response

A live GET response from /view/t_smidata_t_countries: status 200, response body, and response headers.

Warning

When you are testing the API, keep in mind that you are not working in a sandboxed environment. This is the real thing and changes will make it to the underlying database (assuming the API call is successful). Therefore caution is advised.

Warning

Never share a screenshot or copy of the generated curl command. It includes your live session’s Authorization: Bearer token in plain text — treat it like a password.

• Internal API — system admin-only internal API.
• Files — endpoints for binary content.
• Database — where a query’s per-role SELECT/INSERT/UPDATE/DELETE permissions are set.
• Roles & Capabilities — the roles these endpoints are scoped to.