Skip to main content

Developer sandbox account


Trail CRM – Developer Sandbox for API Testing (Beta)​

Welcome to Trail CRM’s developer sandbox environment! This is designed to help you safely test and integrate with our CRM API in a secure and isolated environment. We will work with you to ensure your needs are met through the sandbox environment before implementing changes on your live Trail CRM. Data security and privacy is out top priority, and we will ensure that you can test with peace of mind.

What is the Developer Sandbox Account?​

The developer sandbox account provides your organization with a dedicated, risk-free testing environment. Key features:

  • One sandbox account per organization
  • Access is limited to users with admin permissions in Trail CRM
  • Full access to our API for integration testing

Pre-Requisites to Access the API​

At Trail, Security is our top priority, and to keep your client data secure, we have opted for a two factor authentication method for API Access. We use a Static IP Address and your unique API Key to authenticate every request that comes to our servers. Before you get started with our API, please ensure you have a Static IP Address you can provide us. Once you provide that to us, then you will have access to the Sandbox and API (see below instructions for more detail).

How to Get Access​

  1. Email Request
    Send a request to farran@gettrail.com with your:

    • Organisation Name.

    • Admin user’s email address (registered in Trail CRM). This will be the account used to access the test environment.

    • What you are hoping to achieve with this integration (your User Stories).
    • Static IP Address from where the requests are coming from.

  2. Approval & Setup
    Once we have the previous information, we will whitelist your IP Address and send you follow up instructions on how to access your Sandbox.

  3. Generate your Sandbox API Key
    Log in to your Sandbox, and navigate to “Settings > Integrations > API” to generate your Sandbox API Key.

    • Never share your API Key outside of your business.
    • We will never request your API Key.
    • Should you need a new API Key, you must re-generate it in your Settings, we will not send you a new API Key.
    • If you have any issues, contact farran@gettrail.com.

  4. Ready to go live?
    Let us know when you’re ready to push your API to Production!

    • We need to know what Static IP Address you are using on Production.
    • We will then enable API Access on your Production Site.

API Test Environment Details​

  • API Base URL (Beta)
    https://beta.api.gettrail.com/api/v1

  • Postman Import
    You can also import our API specification into Postman.
    Run In Postman

Testing Guidelines​

  • Ensure you use your sandbox API key when authenticating your requests. This is different to the API Key you will eventually use in Production.

  • The sandbox is intended for testing purposes only, please do not use any real client data.

  • The credentials you use to log into your existing Trail account will be the same for the sandbox environment.

  • Your clients will have their email addresses and phone numbers changed to fake data for privacy.

  • The sandbox has limited functionality, please refer to the Rate Limiting page to understand this in more depth.

Reporting Issues​

Need Help?​

If you have any questions or need help during your testing, don’t hesitate to reach out. Get in touch using our Reporting Issues page.