SWIM API

Current Version: 2.4
Language: Javascript (NodeJS)

Introduction

The SWIM API is the main backend service for the SWIM user interface and provides secure access to the SWIM modeling database. It allows the retrieval of model metadata, input parameters, output variables, scenario themes, and saved model executions.

Additionally, the API provides modules for user authentication and event log handling.

Swagger UI

The Swagger UI provides documentation and samples to access the SWIM Recommender API endpoints. The documentation interface is available by clicking below:

SWIM API - Swagger Docs

Try it out

All of the SWIM API endpoints require token authentication. Tokens can be requested through the API endpoints as a registered or guest user with the following endpoints:

• Guest token request: https://services.cybershare.utep.edu/swim-api/swim-auth-api/authenticateGuest
• Registrant token request: https://services.cybershare.utep.edu/swim-api/swim-auth-api/authenticateGuest

A) To get a registrant user account do the following:

1. Navigate to https://purl.org/swim
2. On the main menu bar select the Login dropdown.
3. Click on the register button to see the registration form.
4. Fill out the form with the requested information.
5. If the submission process is successfull you may use the account credentials straight away.

B) To generate a token and try the SWIM API docs page:

1. Navigate to the API docs page at https://services.cybershare.utep.edu/swim-api/api-docs/
2. Scroll down to the path called /swim-auth-api to see the authentication endpoints.
3. To authenticate as a registrant click on the /swim-auth-api/authenticate endpoint.

4. Click on the try out button.
   
   
   

5. Replace the "string" words with your user email and password and click the execute button.
   
   
   

6. Copy the idToken portion of the response after "JWT" without spaces and final quotes (hidden red text).
   
   

7. Scroll to the top of the page and click on the Authorize button.

8. Fill in the value field by pasting the authentication token.
   
   
   

9. Click on the authorize button.

10. You can now use the rest of the endpoints identified by the lock icon. Note that some endpoints may require a higher access level, contact us if a higher access level is required.