Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
tutorial:rest_api [2021/01/02 01:33]
admin 		tutorial:rest_api [2021/01/02 01:45]
admin removed
Line 6: Line 6:
   * Security and Authorization   * Security and Authorization
   * Swagger UI   * Swagger UI
-  * Integrate using REST APIs+
  
 ===== TestOptimal REST APIs ===== ===== TestOptimal REST APIs =====
Line 14: Line 14:
  
 ===== Organization of REST APIs ===== ===== Organization of REST APIs =====
-REST APIs are grouped and organized in these categories:+REST APIs are grouped and organized in these categories (to match Swagger-UI):
   * ALM - ALM source definition and model requirements   * ALM - ALM source definition and model requirements
   * Agent - TestOptimal Agent APIs: register remote agent and receive agent commands   * Agent - TestOptimal Agent APIs: register remote agent and receive agent commands
Line 30: Line 30:
   * System - perform system functions   * System - perform system functions
   * web-redirect-controller - internal use   * web-redirect-controller - internal use
 +
 +===== Security and Authorization =====
 +Most of the REST APIs are access controlled.
 +
 +Basic Auth is used to authenticate users.  It is highly recommended that you [[ ../configuration#enable_https| enable SSL]] if you access //TestOptimal// server from the internet to prevent your user id/password from being intercepted.
 +
 +
 +===== Swagger UI =====
 +
 +Swagger UI is provided for your convenience.  You can access Swagger UI with the following URL:
 +   http://localhost:8888/swagger
 +   
 +If you are prompted to Login screen, go ahead and login and re-launch the above URL in the same browser session again.
 +
 +
 +