> ## Documentation Index
> Fetch the complete documentation index at: https://deep-white-python.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

> [!TIP]
>
> Zymono's API is free to use, consider [donating](https://zymono.com/donate) or [contributing](https://zymono.com/contribute).

## Quick links

> [card] [API Setup](https://deep-white-python.mintlify.site/api-reference)
>
> Run Zymono products on your website/server

> [card] [Get Started](https://zymono.com)
>
> Get started with Zymono

> [accordion] Add a Zymono button
>
> Use The Zymono API To Embed A Button Into Any Webpage That Launches Your Zymono Report Page.
>
> ```html reportButton.html theme={null}
>   <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>
> ```

> [accordion] How to find panel ID
>
> Go to [https://zymono.com/me/](https://zymono.com/me/) and under Panel Key, click `Click to reveal key`. Copy the following key to your clipboard!

> [accordion] 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.

> [accordion] 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.

> [accordion] 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: [info@zymono.com](mailto:info@zymono.com)
>
> ## API Backend Code
>
> <tip>Not directly given to your in the github or the docs.</tip>
>
> 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

> [card] [Reddit](https://reddit.com/r/zymono)
>
> Our subreddit community

> [card] [Discord](https://dsc.gg/zymono)
>
> Our Discord community

> [card] [Github](//github.com/zymono/API)
>
> Find full information about the API on Github.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.