This modules makes the Foudry VTT API accessible via HTTP.

This is still a proof of concept

You can access the API page through your game URL with the path /modules/api/api.html and you can specify what API to emit with the query string name and you can pass optional arguments to it through the parameters arg0, arg1, arg2, etc.. up to arg9.

Arguments can be in a url encoded JSON string, or a literal string.

The response you receive will be a json object with a boolean success field to indicate if the call was successful or not. If an error occured, a error field will contain the error message. Otherwise, a result field will contain the response from the server.

For the API to work, you must be already logged in with the same browser, and all API calls will be sent as that user.

Get the entire world data : https://example.com/modules/api/api.html?name=world

Set a playlist sound to playing (it's up to you to find the playlist and sound ids) : https://example.com/modules/api/api.html?name=updatePlaylistSound&arg0={"parentId":"playlist_id", "data":{"_id":"sound_id", "playing": true}}&arg1={"embeddedName":"PlaylistSound"}

In the setup page of FVTT, Install the module by entering the following URL : https://raw.githubusercontent.com/kakaroto/fvtt-module-api/master/module.json

Once installed, the API will be available, regardless on whether or not the module is enabled for the world.

This Foundry VTT module, writen by KaKaRoTo, is licensed under a Creative Commons Attribution 4.0 International License.

This work is licensed under Foundry Virtual Tabletop EULA - Limited License Agreement for module development v 0.1.6.