Frequently Asked Questions

Quick answers to common questions

How to enable integration via Tradesquash API?

Integrating with the Tradesquash API

api products

To enable API usage, we need to create a new integration key on the platform. This key is used for API authentication and can be created with three different modes: “read”, “write”, or “both”.

To create a new integration, follow these steps:

  1. In the top menu, click on Integrations.

  2. Click the New Integration button.

  3. Select the organization for which the integration will be created.

  4. Select the scope to be used in the integration (read only, write only, or both).

  5. Enter a name to identify this integration later.

  6. Click Save.

  7. You will be redirected to a screen with important information about the integration such as

    Organization ID

    Integration Key

integration

With the Organization ID and Integration Key you can start the integration process with the API.

To authenticate with the API, follow these steps:

  1. In the top menu, click on Integrations.
  2. Click the API Documentation button.

api_doc

  1. Click on the endpoint called Session and then click the Try it out button
  2. Enter the Organization ID and Integration Key
  3. Click the Execute button.

    You will receive an Access Token in the response, copy this token so we can use it in the next step.

new_session

  1. On the same Swagger UI screen, click the Authorize button.

authorize

  1. Paste the Access Token in the field and then click the Authorize button.

Now you are logged into the API and can use it.