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/register

Intended Use

Register a username with the ZOOMcatalog API and retrieve a user_token for use in subsequent calls to the ZOOMcatalog API.

Return Types

user_token
error

Permitted HTTP Request Methods

POST

HTTP Request Headers

RequiredNameValue
YesContent-Type"application/json"

Parameters

RequiredNameValueLocation
Yesusername<string>- unique identifier representing a user in your applicationRequest Body

Errors

CodeDescriptionLikely Cause
400Wrong format in HTTP body, MUST be a valid and well-form JSON stringThe POST body cannot be parsed into valid JSON
400Parameter must be a valid emailThe username appears to be an email address but cannot be validated
401The token has expiredThe access or user token is too old
404Invalid CLIENT_ID, please contact the administrator.The <ZOOMcatalog_Client_ID> is malformed or properly formed but invalid
500Description will varyError on the API Server
← auth/autologincatalogs/ →
  • Intended Use
  • Return Types
  • Permitted HTTP Request Methods
  • HTTP Request Headers
  • Parameters
  • Errors
ZOOMcatalog
Copyright © 2019 ZOOMcatalog