This document provides a collection of tips and solutions to help you integrate with Builder effectively. It covers common scenarios such as resolving API key mismatches, fixing model name discrepancies, handling common errors and enabling data-bindings in Node environments.
If you get a message in the Visual Editor that there's an API Key mismatch, it means that Builder and your codebase are using different API keys.
- Check the API Key: Since each Space has its own Public API Key, if you have more than one Space in your Organization, make sure you are using the Public API Key for the intended Space.
- Verify the API Key in Builder: To confirm that you're using the correct Public API Key, check that the API Key in your codebase and the Public API Key in Builder for the intended Space are the same.
If you get a message in the Visual Editor that there's a model name mismatch, it means that the Builder model name and the code component name in your codebase aren't the same.
To confirm that you're using the correct model name:
- In Builder, go to Models.
- Open the model in question and go to Advanced.
- Make sure the Unique Identifier is the same as the model name of the component in your codebase.
If you're getting a 404 but aren't sure why, check these things:
- Make sure you've published your Page: In Builder, click the Publish button in the upper right corner of the Visual Editor.
- Check the URL: If you name the page
test2for example, Builder adds a hyphen, so that the URL segment istest-2. - Set the Preview URL: Make sure that you've set the preview URL on the Page Model.
- Restart the dev server: For some frameworks, you might have to restart the dev server.
In certain Node server environments, the builder SDK may require additional initialization steps, namely the initialization of a package called isolated-vm (used to safely evaluate your data bindings).
