TRST Docs

Appearance

Obtaining Credentials ​

This guide shows you how to obtain your API credentials for the trst platform.

Create Your Account ​

  1. Visit app.trstinc.ca
  2. Sign up for a business or developer account
  3. Verify your email address
  4. Complete account setup

Create a Project ​

Projects organize your environments and credentials. Contact trst support or your account manager to create a new project.

You wil need to provide the following information:

  1. Project details:
    • Project name
    • Description
    • Organization (if applicable)
  2. Environment type:
    • Global Environment - For public-facing applications
    • Multi-tenant Environment - For organization-specific systems

Learn more about Projects →

Generate API Keys ​

API keys authenticate your application with the trst platform.

Creating an API Key ​

  1. Navigate to your project in the dashboard
  2. Go to "Settings" → "API Keys"
  3. Click "Generate New API Key"
  4. Configure the key:
    • Name: Descriptive name (e.g., "Production Server", "Development")
    • Scope: Organization-wide or project-specific
    • Permissions: Select appropriate access levels
  5. Copy and securely store the key

API Key Format: {key_id}.{api_key}

Example: AbCd12EfGh34IjKl56MnOp78.XyZ56Abc78Def90Ghi12Jkl34Mno56Pqr78Stu90

Important

API keys are only displayed once during creation. Store them securely - you cannot retrieve them later.

Key Scopes ​

Organization-wide Keys:

  • Access all projects in your organization
  • Used for organization-level management
  • Requires administrator privileges

Project-scoped Keys:

  • Limited to specific project(s)
  • Recommended for applications
  • Follows principle of least privilege

Learn more about Authentication →

Environment Selection ​

When configuring your application, specify the environment:

https://api.prod.trstinc.ca/v1

Always test in the sandbox environment before deploying to production.

Using Your Credentials ​

RESTful API Authentication ​

Include your API key in request headers:

bash
curl https://api.trstinc.ca/v1/projects \
  -H "Authorization: Bearer YOUR_API_KEY"

Security Best Practices ​

Credential Storage ​

DO:

  • Store keys in environment variables
  • Use secure credential management systems (AWS Secrets Manager, HashiCorp Vault)
  • Rotate keys regularly
  • Use different keys for different environments

DON'T:

  • Commit keys to version control
  • Share keys via email or messaging
  • Use production keys in development
  • Hard-code keys in applications

Key Rotation ​

Rotate API keys periodically:

  1. Generate a new API key
  2. Update applications with the new key
  3. Verify the new key works
  4. Revoke the old key

Revoke Compromised Keys ​

If a key is compromised:

  1. Immediately revoke the key in the dashboard
  2. Generate a new key
  3. Update all applications
  4. Review access logs for suspicious activity

Getting Help ​

If you have trouble obtaining credentials:

Next Steps ​

  1. Set up your development environment - Install required tools
  2. Quick Start for Developers - Build your first integration
  3. Review API documentation - Explore available endpoints