Skip to main content

Introduction to our API's

  1. Zakeke API Documentation
  2. Getting Started
  3. About the Zakeke API
  4. Request Endpoint

1. Zakeke API Documentation

Welcome to the Zakeke API documentation, your guide to seamlessly integrating our SaaS solution into various platforms. Our APIs empower you to extend Zakeke beyond our pre-built connectors, allowing integration with commerce platforms not directly supported.

In specific cases, the APIs can be utilized independently, particularly for obtaining order details and customization specifics, even outside the typical integration scenario. This flexibility allows for unique workflows, including the construction of custom processes for order management and production-ready file handling. For instance, users can leverage Zakeke APIs to build custom order workflows and efficiently manage production-ready files, offering a tailored and dynamic integration experience.

Please note: If your intention is solely to utilize the 3D&AR Viewer, no integration is required. Simply create an account with Zakeke, select the 3D&AR Viewer as your preferred tool, upload your 3D models, and generate the link or iframe URL. Afterward, seamlessly embed these elements on your website wherever needed. No integration with Zakeke or API processes required!

2. Getting Started

In all scenarios, the journey begins with the Authentication and Authorization. In Zakeke, each API call requires authentication and authorization using the client's specific account credentials. This ensures secure access to the system's functionalities and maintains the integrity of user data. For a complete integration, follow the Integration section. In cases requiring customization or specific features, leverage individual APIs as needed.

At a certain point, it is crucial to create an account in Zakeke. During the initial phase, this account will be instrumental in obtaining the API keys necessary for integration. Subsequently, after the completion of the integration, your Zakeke account will allow you to access the Zakeke back-office to explore and make use of Zakeke's functionalities and enjoy a free trial!

Start exploring the possibilities and elevate your integration experience with Zakeke APIs!

3. About the Zakeke API

Zakeke APIs are RESTful APIs., that use a HTTP protocol for communication. HTTP GET, POST, PUT and DELETE methods are used to access the API.

4. Request Endpoint

The base url for all API calls is:

https://api.zakeke.com/

This base URL serves as the foundational endpoint for all API requests. Developers must prepend this base URL to their specific endpoint paths to correctly route their API calls to the desired functionalities within the Zakeke system. For example, the endpoint to get orders is:

https://api.zakeke.com/v2/orders