Server Interface / REST API

Server Interface & Callbacks

The CADViewer Conversion Server is designed to expose a powerful REST API while also handling legacy direct file loading. When working with the API, asynchronous processes require a reliable callback mechanism to notify the front-end or middleware when a CAD conversion has successfully completed.

Callback Methods

When a file conversion finishes, the server needs to know where to send the result payload.

• callbackMethod_gatewayUrl_flag: Set to true to force the server to use an external gateway URL for its callback.
• callbackMethod_gatewayUrl: The fully qualified URL the server should POST the conversion results to (e.g., http://localhost:3000). In Docker deployments, this should be the external-facing host URL.
• callbackMethod: The specific route or endpoint name to hit (default: getcadviewercontent).

Extending the Interface

The back-end server routes (located in the /routes/ directory of the repository) handle all REST calls.

You can extend these routes using custom Business Extensions to handle:

• Direct reading/writing of Binary Large Objects (BLOBs) to databases.
• Interfacing with custom internal data structures.
• Adding dynamic preprocessing steps before AutoXchange executes the conversion.

For complete API endpoint references, see the CADViewer RESTFUL API Documentation.