Syndeia Cloud's REST API is published using Swagger which provides a platform for interactive documentation - learn about the REST endpoints and also try them out directly in the documentation.
| Table of Contents | ||
|---|---|---|
|
Accessing REST API documentation
Open a web browser to port 9000 of the root of your Syndeia Cloud instance, ex: http://myhost.mydomain.com:9000. You should see a web page as below. If you do not see the web page below, it implies that your Syndeia Cloud server is not running. Contact your Syndeia administrator. Click on the API icon ("REST API Swagger Documentation").
...
The Swagger REST API Documentation page should open as shown below. The REST endpoints are organized based on the simple conceptual presented conceptual model presented in the previous section (see here).
Making REST API requests through Swagger
The first step in making REST API requests is to sign-in. You should have an account on the Syndeia Cloud sever. If not, request your admin to create an account for you before proceeding further.
...
...
Example Java client for Syndeia CloudSyndeia Cloud also comes with an example Java project (Eclipse and IntelliJ) that demonstrates how to use the REST API. This example project is available for download in the following ways.