API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›ZOOMstudio + ZOOMlibrary

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

Autologin for ZOOMstudio

Who would do this?

Suppliers who have set up ZOOMstudio and want to connect their website login to the ZOOMstudio login

Why would they do this?

Users who have logged in to your website will expect to be able to follow your ZOOMstudio link without logging in a second time. Without the autologin servie, users that are authorized with your website will be taken to another login screen when they follow your ZOOMstudio link. Using the autologin service reduces the number of steps a user has to take to use ZOOMstudio, and often results in higher usage of the tools.

Associated ZOOMcatalog Product

ZOOMstudio

Associated API Endpoints

/auth/authorize/
/auth/autologin/

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 user_token.

  3. Use the user_token, and the link to your ZOOMstudio to make a request to the autologin API endpoint.

  4. Use the autologin uri to embed a link or button to ZOOMstudio on your website. When a user clicks this autologin uri, they will be taken to ZOOMstudio and automatically logged in.

← Add Linked ZOOMcatalogs AND customizable catalogs to your website on one pageUse ZOOMlibrary to Connect Your Product Data to ZOOMstudio →
  • Who would do this?
  • Why would they do this?
  • Associated ZOOMcatalog Product
  • Associated API Endpoints
  • How to do it
ZOOMcatalog
Copyright © 2019 ZOOMcatalog