API architecture
The API is built on CQRS (Command Query Responsibility Segregation) principles. While it follows a REST architecture, there are some important considerations to keep in mind:
-
Write or update requests (e.g., creating an envelope or document) do not return the full inserted or updated data in the response.
-
Instead, the response will include either:
- a status code indicating whether the action was successful, or
- instructions on how to proceed with the next step in the process.
For example, when creating a report or document, the response will return the UID of the newly created entity, which you can then use in subsequent API calls.
-
Base URL:
https://app.grcwatch.com