👋 Introduction

Welcome to the API development workspace. This workspace serves as a single source of truth for the Zylo API we build and helps Zylo's customers get onboarded to the Zylo platform API landscape faster.

Getting started with this workspace

Collections

Any collection found within this workspace is fully visible to the public. These collections are made available to allow for the public to fork, and make use of, how to interface with Zylo's API.

Monitoring Collections

Qodex users of whom fork the 'Zylo, Inc.' collections are able to use Qodex's 'Monitor Collection' option so as to be notified of any changes made. This is highly advisable, as a significant change to the API, and/or the relevant documentation, could result in Zylo customers experiencing errors or unexpected results.

Environments and Variables

To properly, and securely, use the collections found in this workspace you should only place your provided API Key Secret within the 'Production' environment 'token'variable setting. This is located at the top-right of this webpage and is likely set to 'No Environment' by default. Select the drop-down, and select 'Production'. The collections in this workspace are designed to automatically populate this variable in all of the necessary headers for an API call to authenticate successful. It is necessary to change the values of the environment variable 'token' to reflect your own API Key Secret. Once you have selected the correct environment, click on the icon to the right of the drop-down and choose 'Edit' to populate your API Key Secret and then click Save. If you are not using Qodex to make your API calls, and are using these collections for a reference for creating calls outside of Qodex, please see the public facing API Documentation at https://developers.zylo.com/.

Help and Support

For any questions, or concerns, regarding the information found within this Workspace, please email concierge@zylo.com or contact your Zylo representative.