1.2 Accessing the REST API Documentation

The PlateSpin Transformation Manager REST API is available to anyone with a user account in PlateSpin Transformation Manager. For full privileges, the user should be a member of the Administrators group. Use the Web Interface to create a user account for your software developer. See PTM 2019.2 Administrator Guide.

NOTE:Permissions to view results of a trial command is restricted and enforced as it is in the Web Interface based on roles for the user account of the logged-in user.

  1. Launch a supported web browser, then go to either of the following URLs:

    https://<platespin_server_ip_address_or_dns_name>:8183/restapi
    
    https://<platespin_server_ip_address_or_dns_name>:8183/swaggerui

    These web locations are also available using HTTP and port 8182, if you have enabled the HTTP protocol for your PTM Appliance.

  2. When you are prompted for login credentials, enter your PlateSpin Transformation Manager user name and password.

    For information about creating user accounts in PlateSpin Transformation Manager, see Creating a User in the PTM 2019.2 Administrator Guide.