Creating API Tokens and Submission URLs
API tokens are used for authenticating Backtrace API usage and in Submission URLs. Submission URLs are utilized by SDKs and tools to send data to Backtrace.
What You'll Need
- A Backtrace account (log in or sign up for a free trial license).
- Your subdomain name (used to connect to your Backtrace instance). For example,
https://example-subdomain.sp.backtrace.io.
Creating API Tokens
Tokens are granted specific capabilities that restrict their usage to designated purposes.
- In the Backtrace Console, go to Project settings > Project > API tokens and select New.
- Provide a descriptive name, such as
Symbol Token. - Choose one or more capabilities and then click Create.
Creating Submission URLs
The structure of a submission URL differs between hosted environments and on-premise installations.
- Hosted Instance
- On-premise Instance
In a hosted environment, submission URLs follow this format: https://submit.backtrace.io/<subdomain>/<token>/<endpoint>.
| subdomain | If your instance address is `https://example.sp.backtrace.io`, your subdomain will be `example`. |
|---|---|
| token | The API token generated earlier. |
| endpoint | The endpoint corresponds to a specific operation. |
Example
To submit sourcemaps for the subdomain example using token bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7, the URL would be https://submit.backtrace.io/example/bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7/sourcemap.
In an on-premise environment, submission URLs are structured as follows: <your address>:6098//post?format=<endpoint>&token=<token>.
| your address | The URL to your Backtrace services. |
|---|---|
| token | The previously generated API token. |
| endpoint | The endpoint corresponds to a specific operation. |
Example
To submit sourcemaps to the address https://backtrace.example.com using token bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7, the URL would be https://backtrace.example.com:6098//post?format=sourcemap&token=bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7.