Skip to main content

API architecture

The API portal is organized around four backend services because CertHub itself is organized that way. Each service has its own base URL and its own OpenAPI specification.

The four services​

ServiceWhat it ownsTypical use
Tech Doc APIProducts, knowledge units, knowledge topics, schemasResolve IDs, read structure, inspect field definitions
Records APIRecord rows inside a knowledge topicExport records, create evidence records
Tracer APITraceability nodes and edgesRetrieve links between records
Document APIDocument histories and revisionsCreate rendered document objects

The common call sequence​

Most integrations do not start in the API reference and pick random endpoints. They follow a predictable flow:

  1. Use Tech Doc API to resolve product, KU, and KT identifiers and to fetch the KT schema
  2. Use Records API to read or create records
  3. Use Tracer API if you need the relationships between those records

The Document API is separate from that loop. It is for document histories and revisions, not for the usual records-and-evidence workflow.

Records and schemas live in different places​

This is the most important architectural distinction:

  • Tech Doc tells you what a knowledge topic looks like
  • Records gives you the actual rows inside that topic

That is why integrations typically fetch the schema first, then fetch the records, then map opaque form keys to stable semantic names.

List responses​

The public Records list flow documented today does not use dedicated pagination parameters such as page, limit, or cursor. Treat list responses as full filtered result sets and keep your filters as specific as possible.

Polling instead of webhooks​

CertHub does not currently send webhooks or push notifications when product data changes. For recurring synchronization, poll on a schedule or trigger exports from your own workflow.

Next steps​