GraFxStudio-Connector Documentation

Complete guide to configuring and using the GraFxStudio-Connector for your Magento2.x platform.

Configuration Settings

Establish API Connection

Configure the connection between your Magento2.x and your GraFxStudio-Environment. Please go to Stores->Configuration->GraFxStudio

GraFx Credentials

Please enter valid GraFx credentials to establish a connection to your GraFxStudio environment. Please check the official guide of CHILIpublish how to create new API credentials.

Stores → Configuration → GraFxStudio → GraFx Credentials → Grafx Webservice Url:
Url to the universal webservice/api url. Right now it's a universal url "https://integration-login.chiligrafx.com".
But this may change (by CHILIpublish) in the future.

Stores → Configuration → GraFxStudio → GraFx Credentials → Grafx Baseurl:
Url to your private environment.
E.g. "https://cp-xyz-123.chili-publish-sandbox.online/grafx"

Stores → Configuration → GraFxStudio → GraFx Credentials → Grafx Environment:
Name of your environment. E.g. "cp-xyz-123".

Stores → Configuration → GraFxStudio → GraFx Credentials → Grafx Client Id / Api User:
Client-Id from your integration of your environment.

Stores → Configuration → GraFxStudio → GraFx Credentials → Grafx Client Secret / Api Key:
Client-Secret from your integration of your environment.

Stores → Configuration → GraFxStudio → GraFx Credentials → Grafx Frontend Client Id / Api User:
Client-Id from your integration of your environment. Important: Please use the same credentials from the same integration.
This is only a prepartion for an upcoming feature of the GraFx plattform.

Stores → Configuration → GraFxStudio → GraFx Credentials → Grafx Frontend Client Secret: / Api Key:
Client-Secret from your integration of your environment. Important: Please use the same credentials from the same integration.
This is only a prepartion for an upcoming feature of the GraFx plattform.

General Settings

Basic configuration options for the connector.

Enable Connector

Enable or disable the GraFxStudio-Connector functionality in the frontend.

Stores → Configuration → GraFxStudio → GraFx Studio → Enabled: Yes/No (Yes - Default)

Product Integration

Configure how GraFxStudio integrates with your product pages.

Product Attribute

Select which product attribute will trigger the GraFxStudio customization option.
Configuration → GraFxStudio → Product → Customizable Attribute

Button Text

Customize the text displayed on the "Customize" button.
Configuration → GraFxStudio → Product → Customize Button Text

Advanced Settings

Fine-tune the connector for optimal performance.

Cache Lifetime

Set the duration (in seconds) for caching GraFxStudio templates.
Configuration → GraFxStudio → Advanced → Cache Lifetime

Debug Mode

Enable debug mode for troubleshooting integration issues.
Configuration → GraFxStudio → Advanced → Debug Mode: Yes/No

Configuration Parameters

Detailed reference for all available configuration parameters in the GraFxStudio Connector.

Complete list of configuration parameters.

Parameter Name Description Default Value Required

api_key Your unique GraFxStudio API key for authentication None Yes

api_url GraFxStudio API endpoint URL https://api.grafxstudio.com/v1 No

environment Select between production and sandbox environments production No

debug_mode Enable detailed logging for troubleshooting false No

cache_lifetime Duration in seconds for caching templates 3600 No

custom_button_text Text displayed on the customization button Customize Now No

thumbnail_size Size in pixels for template thumbnails 300 No

auto_save_interval Time interval in seconds for auto-saving customer designs 60 No

max_upload_size Maximum file size in MB for customer uploads 10 No

allowed_file_types Comma-separated list of allowed file extensions for uploads jpg,jpeg,png,svg,pdf No

Usage Guide

Learn how to use the GraFxStudio Connector in your daily operations.

1. Setting Up Products

Learn how to configure products to work with GraFxStudio.

Navigate to your product catalog

Select or create a product to be customizable

Set the "Customizable with GraFxStudio" attribute to "Yes"

Assign template IDs from your GraFxStudio account

Save the product changes

2. Managing Customer Designs

Access and manage customer-created designs.

Go to Orders → [Order ID]

View the customized product details

Click "View Design" to see the customer's design

Download design files for production

Frequently Asked Questions

How do I update the connector?

To update the connector, go to your admin panel, navigate to System → Web Setup Wizard → Extension Manager, find GraFxStudio Connector in the list, and click "Update". Follow the wizard to complete the update process.

Why isn't the customization button appearing?

If the customization button isn't appearing, check that:
1. The connector is enabled in the configuration
2. The product has the customizable attribute set to "Yes"
3. A valid GraFxStudio template is assigned to the product
4. Your theme isn't hiding the button with CSS

Can customers save their designs for later?

Yes, customers can save their designs if they are logged in. Their designs will be stored in their account and can be accessed from their account dashboard under "My Designs".