API overview
What the SOM API is for, Postman examples and the authentication workflow.
What the API is for
The SOM API exchanges data between SOM and other systems, such as your website or an enquiry processing service. It supports creating orders programmatically.
An integration developer sets up the connection. First decide which data needs to be sent and which user account the integration will use.
Documentation and Postman examples
Open the SOM public collection on Postman. It contains these examples:
| Request | What it demonstrates |
|---|---|
POST /user/login |
User authentication with the username and password fields. |
POST /order |
Order creation with minimal and extended field sets, plus a request missing required information. |
The order examples include client details, property requirements, price and description. Use the appropriate example as a starting point for your integration.
Workflow
- Authenticate the integration user.
- Obtain the access token from the authentication response.
- Send the token in the
Authorization: Bearer <token>header when working with an order. - Submit the data and check the response to see whether the order was created or any fields need correction.
The example without required information introduces an error scenario. Use your own sign-in details and field values for your requests.
Planning an integration
If the examples do not cover the operation you need, or you have questions about connecting, contact SOM support and describe the data exchange you need.