Skip to main content
Welcome to Polygona! This guide will walk you through the essential steps to get your 3D Blender models up and running on your website using our platform.

Pre-requisites

If you don’t have a Polygona account yet, you’ll need to sign up and create one by visiting the Polygona signup page.

1. Set Up Your Domain(s)

After logging in, you’ll need to set up your domain to use the Polygona API. Normally, a popup will appear when you first log in, prompting you to add your domain. If you missed this step, you can manually add your domain by following these steps:
  1. Navigate to the “API Keys” tab in your Polygona dashboard.
  2. Add your website’s domain to the list of authorized domains (you can add up to 2 domains):
  3. Click the save icon to save your changes.
This step ensures that your API key can only be used on your authorized domains.

2. Upload Your 3D Model

Now, let’s upload your Blender 3D model:
  1. Go to the “Projects” tab in your dashboard.
  2. Click “New Project” to create a new project.
  3. Select your Blender file (.blend) from your computer.
  4. Wait for the upload and processing to complete. This may take a few minutes depending on the complexity of your model.

4. Set and Adjust Parameters

Once your model is uploaded, you should automatically be redirected to the “Edit Project” page: Polygona Edit Project Here you can:
  • Update the project name.
  • Update export formats (STL is selected by default).
  • Select and adjust the parameters you want to expose to your users for customization.
  • Click Save to save your changes and go back to the project list, or click Save & Preview to see how your model will look in the viewer.
Important: We highly recommend adjusting the min/max values for each parameter to ensure that the user can’t break the model, or that some parameter combinations don’t take too long to render. Proper parameter constraints will improve user experience and prevent potential issues.
Pro Tip: For the best end-user experience, aim for fewer, well-chosen parameters rather than a crowded interface. Name your parameters clearly and intuitively. A streamlined, easy-to-understand set of options will lead to higher engagement and satisfaction with your 3D model customizer.

5. Embed in Your Website

Now you’re ready to embed your 3D model viewer in your website:
  1. Go to the “Projects” tab in your dashboard.
  2. Click on icon on the top-right corner of the project you want to embed.
  3. Select the platform you’re using (e.g. React, Shopify).
  4. Copy the embed code and follow the instructions to embed it on your website.
Here’s an example of what the embed code might look like:
import { Editor } from '@polygona/react-sdk';

const MyComponent = () => {
return (
    <Editor
        projectId="YOUR_PROJECT_ID"
        apiKey="YOUR_API_KEY"
      />);
};
Replace 'YOUR_API_KEY' with your actual API key and 'YOUR_PROJECT_ID' with the project ID of the model you want to embed.

Next Steps

Congratulations! You’ve successfully set up Polygona on your website. Here are some next steps you might want to explore: If you encounter any issues or have questions, don’t hesitate to contact our support team.