API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›Common 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 customizable flyers to your website

Who would do this?

Suppliers who have added flyers to ZOOMcustom for customers to customize as their own (users can add their logo and contact information)

Why would they do this?

Using the API to display your customizable flyers on your website ensures that when you schedule, publish, and delete flyers, your website automatically update with the changes. This means that all you need to do is upload and schedule your flyer PDFs on ZOOMcatalog, and we will take care of the rest.

Associated ZOOMcatalog Product

ZOOMcustom Flyers

Associated API Endpoints

/auth/authorize/
/flyers/

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. Use the authorize API endpoint to retrieve an access token.

  3. Use the access token and the user's email address to make a request to the flyers API endpoint to retrieve your ZOOMcustom Flyers. Each ZOOMcustom Flyer 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 ZOOMcustom Flyer on your website, such as:

    • Flyer thumbnail
    • Flyer name
    • Expiration date
    • Description
    • Link to a PDF of the flyer
    • Personalized link to the flyer in the ZOOMcustom tool

Tips

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

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

← Add customizable catalogs to your websiteAdd Linked ZOOMcatalogs AND customizable catalogs to your website on one page →
  • Who would do this?
  • Why would they do this?
  • Associated ZOOMcatalog Product
  • Associated API Endpoints
  • How to do it
  • Tips
ZOOMcatalog
Copyright © 2019 ZOOMcatalog