Using the Swagger Web Interface
The Swagger web interface provides built‑in query capabilities that lets users interact directly with the Image Artist Search (Public) API. All available endpoints and example requests are already defined and ready to use, which makes it easy to explore and test the API without any additional setup or tooling.
Accessing the Swagger Web Interface
You can access Swagger using the following URL:
https://<ImageArtist_domain>/api/swagger/
Replace
<ImageArtist_domain> with the same domain you use to access the Image Artist web interface.
Authentication and Authorization
When users access the API using their Image Artist user account, data access permissions generally match those of the Image Artist web UI. Access is controlled by the assigned user groups and permissions.
- Standard users can access the same data they are authorized to view in the web interface.
- Administrators have full access to all data in the system.
To Authenticate:
Click the Authorize option in the Swagger UI
- Under the OAuth2 scheme, enter your Image Artist user credentials
- Click Authorize to apply your credentials
Once authenticated, you can start making authorized API requests directly from Swagger.
Querying an API Endpoint
To run an API request:
- Select one of the available pre‑defined endpoints.
- Click Try it out.
- If the endpoint requires parameters, enter the required values.
- Click Execute to submit the request.
The API response is returned directly within the Swagger interface, so the results can be reviewed immediately.
The screen capture below shows an example using the /api/1.1/search/ endpoint.
Comments
0 comments
Article is closed for comments.