-
Notifications
You must be signed in to change notification settings - Fork 17
API
aussig edited this page Oct 21, 2023
·
8 revisions
This page is for developers and describes the plugin's API for sending data to web services.
The API defines three endpoints:
-
GET /discovery: Requests information from the server about its requirements and configuration. This allows the server to declare which endpoints it supports, to declare which events it is interested in receiving, to further filter those events based on RegEx pattern matching, and to define general parameters such as how often it would like to receive data and the size of event batches. -
PUT /activities: Sends aggregated and collated BGS and Thargoid War data for all activity by the user within the current tick. -
POST /events: Sends journal events from the E:D game journal. Events are primarily raw data directly from the journal, but are slightly enhanced by BGS-Tally with some additional useful fields.
The latest version of all three endpoints is documented on Apicurio here.
The above documentation is always the very latest and may include as-yet unreleased features. Previous versions of the API are documented here: