Using the Builder API Key
An API key is an alphanumeric string that you can use to connect your code base with Builder. Use the Builder Public API Key to integrate with Builder.
An example of a Builder API Key is bb209db71e62412dbe0114bdae18fd15.
This document walks you through the following:
Prerequisites
To get the most our of this document, you should have the following:
- A Builder account
- An app in your framework of choice
Tip: The Builder Public API Key is public, meaning that you don't have to keep it private. Because of this, there are no inherent security risks in it being publicly viewable, for example, on GitHub.
Finding your Public API Key
To find and copy your Public API Key, take the following steps:
- Within Builder, go to the Account Settings section.
- Click the copy icon to the right of the Public API Key field.
Using your Public API Key in your framework
Most JavaScript apps use builder.init() to pass in the Public API Key. Replace YOUR_API_KEY with the Public API Key you copied from Account Settings.
The following example shows what an actual Public API Key looks like when passed into builder.init().
Using your Public API Key in Angular
In Angular, pass your API Key into BuilderModule.forRoot(), by replacing YOUR_API_KEY with the Public API Key you copied in Account Settings. Place the forRoot() method in the @NgModule() imports array.
When you replace the YOUR_API_KEY placeholder, it looks similar to the following example.
Next steps
With your API Key in place, you can integrate powerful Builder features. To get started, check out the following tutorials:
- Integrating Pages: set up your app so teammates can build Pages on their own.
- Integrating Sections: integrate Section building for reusable content
- Integrating CMS Data: create structured reusable data across your site
- Integrating Symbols: elegantly reuse data across your app
- Integrating Custom Components: use your custom components in Builder's drag-and-drop UI
