API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›api.zoomcatalog.com/

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

https://api.zoomcatalog.com/auth/autologin

Intended Use

Exchange a ZOOMcatalog URI for a ZOOMcatalog autologin_uri.

Return Types

autologin_uri
error

Permitted HTTP Request Methods

GET

HTTP Request Headers

RequiredNameValue
YesContent-Type"application/json"
YesAuthorization<user_token>

Parameters

RequiredNameValueLocation
Yesuri<string>Query String
NoredirectNo ValueQuery String

Notes

If the redirect parameter is used, this endpoint will not return an autologin_uri. Instead, it will issue a redirect to the autologin_uri.

Errors

CodeDescriptionLikely Cause
400The token is corruptedMalformed user or access token
400The provided access token does not contain the scope requiredThe user associated with the user_token does not have permission to access the resource
400You should send a user access token, please check the access token you are sendingAn access_token was used where a user_token should be used
400Invalid User TokenThe token is a recognized as a JWT but is not valid as a User Token for some reason
401The token has expiredThe access or user token is too old
← auth/authorizeauth/register →
  • Intended Use
  • Return Types
  • Permitted HTTP Request Methods
  • HTTP Request Headers
  • Parameters
  • Notes
  • Errors
ZOOMcatalog
Copyright © 2019 ZOOMcatalog