How to test the API?
Testing with Swagger
To test the API endpoints using Swagger, follow these steps:
- Navigate to the Swagger UI using one of the environments provided in the left-hand side of the screen.
Production API
This environment is ready for you to test your integration.
This environment is ready for you to test your integration.
- Look for the "Authorize" button at the top of the page and click on it.
- In the authorization popup, you'll need to provide the access token you received from the authentication section.
Example:
Nxsys-oauthtoken 1234567890- Click "Authorize" to generate an access token.
- Once authorized, you'll see a closed lock icon next to the secured endpoints.
- To test an endpoint:
- Expand the endpoint you want to test.
- Click on the "Try it out" button.
- Fill in any required parameters.
- Click "Execute" to send the request.
- Swagger will display the response, including the status code, response body, and headers.
Remember to log out by clicking the "Authorize" button again and then "Logout" when you're done testing.
Keep your access token confidential and do not share it with others.
Testing with Postman
Coming Soon
Table of Contents