API: Settings Page Overview

 

API settings page is where you can add, change, and manipulate your API scripts.


1. Script Library Section

This dropdown includes a list of all the curated scripts that Roll20 offers for one-click installation. This list is continuously updated with scripts that are approved for one-click installation through Roll20. However, you can still install any scripts from our official Roll20 GitHub library by adding them manually, or you can even create your own scripts from scratch!

Selecting a script will display an additional section with information on the script. This information includes how to use the script, who the author is, what the current version is, and other important details. We highly recommend you review all of the information available before you install a script. 

Whenever you are ready to install, there will be an Add Script button as well as an Import button.


2. New Script Section

It is strongly recommended that you have a basic understanding of coding and JavaScript before you make any changes here. This section allows you to add code directly into the API and save it as a script. This section includes a built coding editor to add and manipulate your script code. Also, for when you are ready to make changes, there is are both a Disable Script and Save Script buttons for making those updates. Click here for more advanced API reading and for information on how to create your own scripts.


3. Restart API Sandbox Button

This button allows you to restart the instance of the API that is running. This effectively reboots any API scripts and restarts any other affected processes.


4. API Output Console

The API Console is your "window" into your scripts. Since API Scripts run in a special environment, you don't have direct access to them while they are running to view information on the script's results or errors. The API Console brings this information out of the sandbox so you can view it while you are editing your scripts. All log() commands will show here, as well as any errors that are encountered during the execution of your scripts.

Was this article helpful?
0 out of 4 found this helpful