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 ZOOMcatalogs to your website

Who would do this?

Suppliers who have converted their catalogs into ZOOMcatalogs

Why would they do this?

Using the API to display your ZOOMcatalogs on your website ensures that when you publish or delete a catalog, your website automatically updates with the changes. This means that all you need to do is upload your catalog PDFs to ZOOMcatalog when ready with go live and expiration dates, and we will take care of the rest.

Associated ZOOMcatalog Product

ZOOMcatalogs

Associated API Endpoints

/auth/authorize/
/catalogs/

How to do it

  1. Use the authorize API endpoint to retrieve an access token.

  2. Use the access token to make a request to the catalogs API endpoint to retrieve your ZOOMcatalogs.

  3. Embed information from the ZOOMcatalogs on your website, such as:

    • Catalog cover thumbnail
    • Catalog name
    • Link to the full catalog

Tips

Use text to help users understand what they can do with your ZOOMcatalogs.

For Example:
"Click view to open, browse and share a catalog."
"Use the catalog link to add it to your website, share with customers post on social media, and more!"

← ConventionsAdd customizable catalogs to your website →
  • Who would do this?
  • Why would they do this?
  • Associated ZOOMcatalog Product
  • Associated API Endpoints
  • How to do it
  • Tips
ZOOMcatalog
Copyright © 2019 ZOOMcatalog