Skip to main content
All CollectionsIntegrationsAPI Integration
Getting Started with API Integration
Getting Started with API Integration

Learn how to integrate your custom store with Gelato's APIs by following our detailed guide, covering documentation, testing, and key points

Updated over a week ago

This article provides a comprehensive guide to integrating your custom store with Gelato's APIs, ensuring a seamless and efficient experience.


Technical Documentation for the API Integration

Before diving into the integration process, it's crucial for your technical team to be well-versed in our technical documentation. You can access it here.

This documentation serves as a comprehensive resource, outlining all the necessary details and requirements. Make sure to review it periodically, as updates and new functionalities may be added.


Gelato Dashboard

Consider the Gelato Dashboard your command center for all things related to your Gelato API integration. It provides:

  • In-depth information on products offered by our global network, including pricing details.

  • Complete control over orders placed through the Gelato API.


Design Requirements and Product Mapping for API Integration

To ensure optimal print results, it's important to familiarize yourself with our design requirements. Please make sure the files you submit adhere to these guidelines.

Additionally, a clear understanding of product UIDs and how to map your products to Gelato's standards is essential for a smooth integration.


Products, Pricing, and Shipping for API Integration

For detailed information regarding the products we offer, their specifications, geographical limitations, and pricing based on country and quantity, refer to the comprehensive product catalog accessible through our dashboard. You can find further insights into products and designs here.

As shipping prices are dynamic and based on real-time availability and methods in each country, they are not listed on the dashboard. For a comprehensive understanding of how shipping prices are determined, please refer to the information provided here.


Testing Your API Integration

Once you're ready to test your integration, you can generate a key and include it in the X-API-KEY header of your HTTP requests. This enables you to:

Additional testing functionalities are available, allowing you to explore and understand the API's capabilities further. You can also utilize the API Portal to request quotes and place test orders even before your integration is fully completed. This provides an opportunity to gain an initial understanding of the required information, the correct way to match files with the appropriate product UIDs, and the responses you can expect to receive.

When you use a key in your Live environment, you can experience the full order fulfillment process, including shipping and delivery to the provided address, allowing for end-to-end testing.


Additional Information

We've compiled some additional resources that you might find helpful:

  • Shipping: Essential details about our shipping processes.

  • Customer Service: A detailed explanation of our customer service procedures and the information we require from you.

  • Terms of Use: Our general terms of use for the service.

Did this answer your question?