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
...
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).
...
The sign-in request authenticates the user and returns a token if succesful. The token is then used for every REST API request to the Syndeia Cloud server. Follow the steps below to sign-in and register the token so that you do not have to specify it for each request.
1. Click on POST /signIn button under the Auth category.
2. Click the Try it out button on the right-hand side (RHS). The "User info for signIn" fields should show up.
3. Click the Edit button. The field should now become editable.
4. Fill out your account credentials.
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
...
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:.
