Skip to main content

Security and Authentication

The Topl endpoints use API keys to allow access. You can obtain your API key through creating a project in the <<glossary:BaaS>> developer portal (please view the guide for <<glossary:BaaS>> Developer Portal Onboarding for the details on how to setup your first project).

[block:image] { "images": [ { "image": [ "https://files.readme.io/a314980-Screen_Shot_2021-03-24_at_9.46.56_AM.png", "Screen Shot 2021-03-24 at 9.46.56 AM.png", 2560, 1378, "#fafafa" ] } ] } [/block] To access the APIs, include the API key in the HTTP Header of your HTTP request:

x-api-key:yourapisecret

Alternatively, you can add the API key into the Requests module object of a BramblJS instance (using our BramblJS library).

Examples​

[block:callout] { "type": "info", "title": "Please note!!", "body": "You must replace yourapisecret or YOUR_API_KEY in the examples with your actual API key provided by Topl\n\nIn addition, you must replace {{myProjectId}} with the actual projectId provided by Topl" } [/block]

[block:callout] { "type": "info", "title": "Network Prefix", "body": "There are two BaaS network prefixes. If you want to use the main net, set networkPrefix = toplnet otherwise set networkPrefix = valhalla for using the test net" } [/block]

[block:code] { "codes": [ { "code": "const BramblJS = require('brambljs');\nconst brambl = new BramblJS({\n networkPrefix: \"valhalla\", // applies to Requests and KeyManager\n password: \"topl_the_world!\",\n Requests: {\n url: \"https://valhalla.torus.topl.network/{{myProjectId}}\", // make sure that the project ID from the BaaS portal is included. \n apiKey: \"YOUR_API_KEY\" // set api key for network\n }\n });", "language": "javascript" } ] } [/block] Additionally, you must provide a project ID for each request made. Your Project ID can also be found in the BaaS Portal. [block:image] { "images": [ { "image": [ "https://files.readme.io/668d997-Screen_Shot_2021-03-25_at_3.27.33_PM.png", "Screen Shot 2021-03-25 at 3.27.33 PM.png", 3360, 1876, "#fafafa" ] } ] } [/block]

[block:callout] { "type": "danger", "title": "Important", "body": "Note that our BaaS offering has a rate limit defined at 5 requests per second. Please contact us if that is not sufficient for your use case!" } [/block]