Welcome to the Zymono docs!

Find all the information about how to use Zymono and it’s API here.

Getting Started

What you need

• Make sure to have a Zymono account
• Make sure you have a Github account

Zymono’s API is free to use, consider donating or contributing.

Quick links

API Setup

Run Zymono products on your website/server

Get Started

Get started with Zymono

Add a Zymono button

Use The Zymono API To Embed A Button Into Any Webpage That Launches Your Zymono Report Page.

reportButton.html

  <script type="module" id="zymono-script">
  //THIS CODE WAS MADE FOR THE ZYMONO API AND FOLLOWS OUR API LICENSE. 
  //https://github.com/zymono/API/LICENSE.md
  
  //https://github.com/zymono/API
  
  window.sessionStorage.setItem('gameID', 'Your_Panel_ID_HERE')
  
  import { createButton, report } from 'https://api.zymono.com/api.js'

  createButton()
</script>

How to find panel ID

Go to https://zymono.com/me/ and under Panel Key, click Click to reveal key. Copy the following key to your clipboard!

API safety

Make sure to store all instances of your panel key in an environment variable. Your panel key must remain hidden otherwise users can access the API on your behalf.

What's the API

The Zymono API gives you the ability to turn any iframe into a Zymono panel where you can manage reports without having every user authenticate and go through the collaboration process.

Licenses

API Code Provided To You

You may use this code snippet provided to you by Zymono ONLY for use of adding a report button or Zymono Panel to your website. You may not share the code anywhere or sell/make profit from it. We own the strict rights to the code and have the ability to ban you from using it at any time! Your are absolutely not allowed to remove any attribution! You are not permitted to edit any code imported or referenced in the API code snippet!

Failure to comply with this license will result in legal action being taken and your use of the software being banned.

Contact: [e-mail]

API Backend Code

Copyright (C) 2023 Zymono. All Rights Reserved. No Copying Allowed! NO EDITING OR VIEWING ALLOWED UNDER ANY CIRCUMSTANCE!

Support

Get help with our API or other Zymono products

Reddit

Our subreddit community

Discord

Our Discord community

Github

Find full information about the API on Github.