Damian edited this page Apr 14, 2015 · 11 revisions

Welcome to the InkSoft API Wiki.

This API guide and wiki is geared toward InkSoft customers and their development teams to help guide them through integrating InkSoft with another website or application. InkSoft has many options and API calls so you can use as much or as little of the API as you need to get the end-user experience you're after.

This wiki is intended for example scenarios, walkthroughs, and sample code. For details on the inputs/outputs of a particular API call, please consult the InkSoft API documentation available in the admin portal. It is also often helpful to note that the InkSoft design studio communicates with the system via the same API we provide to customers, so you should almost always have a working example for all product, art, design, user, and cart operations you're interested in. You can watch the API communication between the design studio and the InkSoft backend with your favorite http traffic watcher (we like Chrome's built-in network tools.)

Common InkSoft Design Studio integration approaches

At InkSoft, we find that some customers want to use our design studio, but don't want to use any of the InkSoft templates out of the box. They may want their own product pages, art pages, or a unique shopping cart solution. There are three common solutions to integrating the InkSoft design studio with a non-InkSoft site.

  1. Embed the Design Studio using the InkSoft Design Studio code generation page, and use the built-in design studio pages for product catalog, art, my designs, view cart, and checkout. This solution is by far the simplest and most common, and requires no programming knowledge. For detailed instructions and a walkthrough of how to embed the design studio into your site, go to http://www.inksoft.com/inksoft-design-studio-embed/.

  2. Embed the Design Studio and integrate it with an external cart for the view cart and checkout pages. This solution involves telling the design studio to start the checkout process by allowing the user to select sizes and save their design, then it forwards the user to an external cart URL with relevant information so the external cart can take the user through the rest of the checkout process. See details on this kind of integration.

  3. Embed the Design Studio and forward to an external cart/application right after the design is saved. This solution is for users who do not want the design studio to ask for any information other than what's required to save the design. Once the design is saved, the design studio will forward the user to an external page with no information other than the design ID, which can be used in subsequent API calls. See details on this kind of integration.

Reference pages