Integration Fields

Integration Fields allow you to use Magento product and category data directly in your Prismic documents. This creates a dynamic connection between your Magento catalog and Prismic content.

Configuration

Basic Setup

1. Go to Stores > Configuration > Elgentos > Prismic.IO
2. Navigate to Integration Fields section
3. Configure:
4. Product Attributes to sync
5. Product Visibility settings
6. Access Token for security
7. Disabled Products sync option

Default Product Attributes

The following attributes are always available: - name - image - status - short_description - updated_at

Setting Up in Prismic

Creating Integration Fields

1. Go to your Prismic dashboard
2. Navigate to Settings > Integration fields
3. Create a new Custom Integration
4. Configure the endpoints:
5. Products: https://your-store.com/prismicio/integration/products
6. Categories: https://your-store.com/prismicio/integration/categories
7. Add the Access Token if configured in Magento

Adding to Content Types

{
  "Main": {
    "featured_product": {
      "type": "IntegrationFields",
      "config": {
        "catalog": "product_catalog",
        "label": "Featured Product"
      }
    }
  }
}

Available Endpoints

Products Endpoint

GET /prismicio/integration/products

Returns product data in Prismic-compatible format:

{
  "results_size": 100,
  "results": [
    {
      "id": "123",
      "title": "Product Name",
      "description": "Short description",
      "image_url": "https://example.com/media/catalog/product/image.jpg",
      "last_update": 1673891234,
      "blob": {
        // All selected product attributes
      }
    }
  ]
}

Categories Endpoint

GET /prismicio/integration/categories

Returns category data:

{
  "results_size": 50,
  "results": [
    {
      "id": "4",
      "title": "Category Name",
      "description": "Category description",
      "image_url": "https://example.com/media/catalog/category/image.jpg",
      "last_update": 1673891234,
      "blob": {
        // All category attributes
      }
    }
  ]
}

Security

Access Token Protection

1. Configure an access token in Magento:

   <prismicio>
       <integration_fields>
           <access_token>your-secret-token</access_token>
       </integration_fields>
   </prismicio>
   

2. Use the same token in Prismic's Integration Fields setup

Authentication Headers

The endpoints use Basic Authentication: - Username: Your access token - Password: Can be left empty

Configuration Options

Product Sync Options

1. Visibility Settings

   <visibility>4</visibility>  <!-- Catalog, Search -->
   

2. Disabled Products

   <sync_disabled_products>0</sync_disabled_products>
   

3. Custom Attributes

   <attributes>sku,price,special_price</attributes>
   

Implementation Examples

Basic Product Integration

{
  "Main": {
    "related_products": {
      "type": "Group",
      "config": {
        "fields": {
          "product": {
            "type": "IntegrationFields",
            "config": {
              "catalog": "product_catalog"
            }
          }
        }
      }
    }
  }
}

Category Selection

{
  "Main": {
    "featured_category": {
      "type": "IntegrationFields",
      "config": {
        "catalog": "category_catalog"
      }
    }
  }
}

Best Practices

1. Performance
2. Limit the number of attributes synced
3. Use pagination for large catalogs

4. Consider caching strategies

5. Security

6. Always use access tokens in production
7. Limit exposed attributes to necessary data

8. Regularly rotate access tokens

9. Data Management

10. Sync only required product visibility types
11. Consider impact of disabled products

12. Keep attribute selection minimal

13. Maintenance

14. Monitor API response times
15. Review and update synced attributes
16. Check for outdated product references

Troubleshooting

1. Authentication Issues
2. Verify access token configuration
3. Check authentication headers

4. Confirm Prismic integration setup

5. Missing Data

6. Check product visibility settings
7. Verify attribute configuration

8. Confirm product/category status

9. Performance Problems

10. Review number of synced attributes
11. Check pagination settings
12. Monitor API response times