Open API Documentation
Axon Synapse communicates with third-party applications via HTTP (a.k.a. RESTful) APIs. It uses the OpenAPI Specification to define the methods and types available in those APIs.
Synapse API
This is the API third-party applications use to communicate with an Axon Synapse instance. It provides means to
-
sends commands, queries, and events
-
register command handlers, query handlers, and event handlers
-
obtain all events associated with an aggregate
The Axon Synapse API page contains the documentation for this API.
Client API
The Client API comes in two flavors. Both specify the payload client applications should expect when Axon Synapse sends messages to them. Clients specify the actual endpoints and which API type Synapse should use when they register.
Client API - message
When a third-party application registers a client handler, it may specify http-message as endpointType. In such a case, Axon Synapse sends a JSON object. It places the message (command, query, event) payload in that object’s payload field.
See Client Message API page for the complete structure of those messages.
Client API - raw
When a third-party application registers a client handler, it may specify http-raw as endpointType. In such a case, Axon Synapse sends the actual message (command, query, event) as payload and all the relevant information in HTTP headers.
See Client Raw API page for the complete structure of those messages.