REST Support
Broadleaf provides a basic endpoint for creating sites via a RESTful URL. Please follow the REST Tutorials
section to enable the Jersey servlet in charge of responding to REST API requests.
Once REST support is configured, the API to create a new site may be accessed at /global/multitenant (e.g. http://localhost:8080/global/multitenant).
The API expects a POST and is looking for the following variables:
| Type | Name | Optional |
|---|---|---|
| String | siteName | |
| String | domainName | Y |
| String | domainPrefix | Y |
| String | userName | |
| String | emailAddress | |
| boolean | useEmailForUserName | Y |
| String | password | |
| String | confirmPassword |
Accessing a REST service in the name of a specific site works just like the customer facing components. The system will
rely on the blSiteResolver component to determine the data context of the REST api call.
For companies providing public facing REST services, customization is required to limit the scope of access to a specific
tenant.