Table of Contents outline true
Overview
Swagger is an interactive documentation system that also allows you to conveniently try out & make REST API calls from the documentation page itself.
...
The Swagger REST API Documentation page should open as shown below. The REST endpoints are organized based on a system of repositories, containers, artifacts, and relations (see Conceptual Model for an overview).
...
To
...
Login
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.
...
9. Paste the copied token (previous step) in the Value field, and then click the Authorize button, followed by clicking the Done button.
To
...
Create a
...
New User
10. Click on POST /signUp button,
11. Click the Try it out button. The "User info for signUp" fields should show up.
12. Click the Edit button. The field should now become editable.
13. Fill out the requested fields, ie: first name, last name, email, password.
14. Click the blue Execute button.
15. 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.
...
To
...
Reset a
...
Password
16. Click on POST /resetpassword button,
...