App Keys (Admin)

App Keys can be used by those customers who want to access the STRATUS Open API. The application programming interface (API) is very easy to set up and use.  It can be accessed via most modern programming languages. It may be beneficial to create a new A360/STRATUS user specifically for each integration.  This approach will provide maximum flexibility regarding API data access and permissions in the future.

Configure an App Key

To use the Open API:

1. Generate an application key in Admin > Company > App Keys.
   1. App Name: A name to identify this particular integration.
   2. Key: The unique app-key used by web api methods.
   3. Regenerate: The way to reset an existing key for security purposes.
   4. Partner App: App Keys used for partner apps (PypeServer, Novarc, FieldOrderz, GTP Connect, GTP Lightning, RazorGage, VicTools, WattsMueller, etc.) require this parameter to be selected. If the App Key is an internal application, no action is required.
   5. Run as User: The STRATUS user account that is used for project access and permissions.
   6. Modified By: The last admin user to modify the application key entry.
   7. Active?: A toggle to enable/disable the given app-key.
      
      
      
2. Test the API.

   1. Go to https://api.gtpstratus.com to view and test out the available STRATUS Open API web methods.  The API is fully documented with available data, methods, response details, objects, etc.  By copying-pasting your application key into the app-key authorize field above the methods, you can test them out by clicking the Execute button.  The response details will be displayed.

   2. Copy/paste the API Key to use in the OpenAPI portal. Note: The API Key can be regenerated at anytime.
      
      
      
      

Configure App Key for PyperServer

1. Generate an App Key where the Partner App = PypeServer.
   
   
2. During the PypeServer installation process, enter the generated Key when prompted.