Gather Wiki
(Created page with "== Gather API == Official Docs: https://support.gather.town/help/api-integration Community Showcase: https://www.youtube.com/watch?v=Sh1Ey-5l7qM === Github Resources === *...")
Tag: Visual edit
 
Tag: Visual edit
Line 1: Line 1:
 
== Gather API ==
 
== Gather API ==
  +
The API is HTTP only for now. Websockets in development.
  +
 
Official Docs: https://support.gather.town/help/api-integration
 
Official Docs: https://support.gather.town/help/api-integration
  +
  +
'''What can I do through the API?'''
  +
  +
* Create new spaces by copying over old spaces.
  +
* Pull down the map file from Gather (a JSON file containing links to background/foreground pngs, objects, collisions, etc).
  +
* Update a map file on Gather.
  +
* Pull down from Gather the email guestlist associated with a space.
  +
* Update the email guestlist on Gather.
  +
  +
'''What can I not do through the API?'''
  +
  +
* Pull down or update the roles assigned to each of the users on the guestlist.
   
 
Community Showcase: https://www.youtube.com/watch?v=Sh1Ey-5l7qM
 
Community Showcase: https://www.youtube.com/watch?v=Sh1Ey-5l7qM

Revision as of 13:32, 26 August 2021

Gather API

The API is HTTP only for now. Websockets in development.

Official Docs: https://support.gather.town/help/api-integration

What can I do through the API?

  • Create new spaces by copying over old spaces.
  • Pull down the map file from Gather (a JSON file containing links to background/foreground pngs, objects, collisions, etc).
  • Update a map file on Gather.
  • Pull down from Gather the email guestlist associated with a space.
  • Update the email guestlist on Gather.

What can I not do through the API?

  • Pull down or update the roles assigned to each of the users on the guestlist.

Community Showcase: https://www.youtube.com/watch?v=Sh1Ey-5l7qM

Github Resources