API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›Advanced Usecases

About

  • Introduction
  • Conventions

Guides

    Common Usecases

    • Add ZOOMcatalogs to your website
    • Add customizable catalogs to your website
    • Add customizable flyers to your website

    Advanced Usecases

    • Add Linked ZOOMcatalogs AND customizable catalogs to your website on one page

    ZOOMstudio + ZOOMlibrary

    • Autologin for ZOOMstudio
    • Use ZOOMlibrary to Connect Your Product Data to ZOOMstudio

Endpoints

    api.zoomcatalog.com/

    • auth/authorize
    • auth/autologin
    • auth/register
    • catalogs/
    • catalogs/all
    • categories/
    • categories/all
    • categories/catalogs
    • custom/catalogs/
    • custom/catalogs/personalized
    • flyers/
    • flyers/personalized

    beta-library.zoomcatalog.com/

    • product-api

Resources

  • access_token
  • autologin_uri
  • catalogs_with_personalize
  • catalogs_without_personalize
  • category_descriptors
  • category_details
  • category_catalogs
  • custom_catalogs_with_actions
  • custom_catalogs_without_actions
  • Errors
  • flyers_with_actions
  • id
  • image
  • sample
  • subcompany
  • user_token
  • ZOOMcatalog_Client_ID
  • ZOOMcatalog_Client_Secret

Specifications

  • product
  • product/variations
  • product/variations/price_variance
  • product/media

Add Linked ZOOMcatalogs AND customizable catalogs to your website on one page

Who would do this?

Suppliers who have converted their catalogs into ZOOMcatalogs, uploaded an unbranded version of each to ZOOMustom, and had their catalogs linked by ZOOMcatalog staff. If you plan to implement catalogs this way, you will need to contact your account rep to have your catalogs linked.

Why would they do this?

Using the API to display your linked catalogs on your website on one page ensures that when you schedule, publish, and delete catalogs, your website automatically updates with the changes. This means that all you need to do is upload your catalog PDFs to ZOOMcatalog, and we will take care of the rest. Using linked ZOOMcatalogs and ZOOMcustom catalogs makes it easier to have a single “Catalogs” page on your website (rather than a separate page for ZOOMcatalogs, and a separate page for ZOOMcustom catalogs). Each catalog preview can include a button to view (open ZOOMcatalog) and to customize (launch ZOOMcustom tool).

Associated ZOOMcatalog Product

Linked ZOOMcatalogs and ZOOMcustom Catalogs

Associated API Endpoints

/auth/authorize
/catalogs/all

How to do it

  1. Authorize a user on your own website (e.g., have the user log in with an email and password).

  2. Send the authorized user's email address to the authorize API endpoint to retrieve a user token.

  3. Use the user token to make a request to the /catalogs/all/ endpoint to retrieve your linked ZOOMcustom Catalogs. Each linked ZOOMcustom Catalogs will contain a personalized link specific to the user from step 1. When the user clicks this link, the ZOOMcustom tool will launch and the user will automatically be logged in to the tool.

  4. Embed information from the linked ZOOMcustom Catalogs on your website, such as:

    • Catalog cover thumbnail
    • Catalog name
    • Personalized link to the ZOOMcustom Catalog in the ZOOMcustom tool
    • Link to the full ZOOMcatalog

Tips

Use text to help users understand what they can do with your linked ZOOMcustom Catalogs

For Example:
"Choose a catalog to customize. Click the customize button and follow the steps to add your logo, contact information and save."
"Share your new catalog on your website, in emails, on social media, and more!"

← Add customizable flyers to your websiteAutologin for ZOOMstudio →
  • Who would do this?
  • Why would they do this?
  • Associated ZOOMcatalog Product
  • Associated API Endpoints
  • How to do it
  • Tips
ZOOMcatalog
Copyright © 2019 ZOOMcatalog