Skip to main content
SecurityTrax

Getting Started

Our API is generally RESTful, following the json:api specification, with a few variances.

Integrator Key

In order to work with our web services you will need to have an integrator key assigned.  There are separate keys created for our staging and production environments.  In order to obtain your integrator keys fill out the form found here.

This case-sensitive key will be provided as the “X-SecurityTrax-IntegratorKey” in every request header.

Environments

There are two environments: Staging (for development) and Production (Live data). 

Staging

The staging environment will allow developers to interact with a test system to ensure their application is working as designed before moving to production.  You will need to use the staging integrator key and credentials to access the resources.  These will both be provided when your integrator key is assigned.

 

Web Application URL:

Use this URL to log into the SecurityTrax application.  From here you can see if the work you are performing is having it's intended impact.

 https://app.staging.securitytrax.com/sandbox/login  

 

API Services URL:

Direct all web service calls to this root URL.

https://api.staging.securitytrax.com/sandbox/user/v1/

 

Swagger Docs URL:

Use this URL to lookup details of each endpoint and how to use them.

https://api-docs.staging.securitytrax.com/sandbox

 

Production

In order to use your tools against production you will need to know a couple items:

  1. Profile name of the company you are working with. This will be the string following the base URL.  For example: https://app.securitytrax.com/sandbox.  In this case sandbox is the company profile name.  Each company is assigned a unique name which they can provide to you.
  2. Credentials must be granted by each company you interface with.  The company will need to create the user account details and ensure that it has the necessary permissions.
     

Web Application URL:

Use this URL to log into the SecurityTrax application.  From here you can see if the work you are performing is having it's intended impact.

https://app.securitytrax.com/company_profile/login

 

API Services URL:

Direct all web service calls to this root URL.

https://api.securitytrax.com/company_profile/user/v1/

 

Swagger Docs URL:

Use this URL to lookup details of each endpoint and how to use them.  In this case no company specific profile is needed as the docs are the same for all companies.

https://api-docs.securitytrax.com/sandbox

  • Was this article helpful?