Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Syndeia Cloud's REST API is published using Swagger which provides a platform for interactive documentation - learn about the REST endpoints  endpoints and also try them out directly in the 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 like the one 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").

Image Removed 


Image Added 


Once you log in with your Syndeia username and password, you will be redirected to the Syndeia Cloud 3.3 Home Page. The link to the Swagger documentation is available on this page in the bar on the left as highlighted below. Click on the API option as shown below.

Image Added


The Swagger REST API Documentation page should open as shown below. The REST endpoints are organized based on the simple conceptual model presented in the previous section (see here).

Image RemovedImage Added

Making REST API requests through Swagger

...

3.  Click the Edit button.  The field should now become editable.  

4.  Fill out your account credentials.
    Image RemovedImage Added

​5.  Click the blue Execute button.  

6.  If successful, you should receive an HTTP 200 response back with JSON data.  If there was a form error, you should receive an HTTP 4XX response back with an appropriate error message.  

7.  Select and copy the token JSON string into the clipboard
    Image RemovedImage Added

8.  Click the Authorize button at the top of the page (RHS)​, a popup screen should show.  
    Image RemovedImage Added
9.  Paste the copied token (previous step) in the Value field, and then click the Authorize button, followed by clicking the Done button.

...

10.  Now you should be able to use any of the other API endpoints on the page and have your token automatically submitted with your requests.
    Image RemovedImage Added