EmergencyOS Endpoints

Requests die von deinem Server bei bestimmten Events an die EmergencyOS API gesendet werden.

Beachte, dass das Addon Datenbank Sync aktiviert sein muss

Um die Funktionen der API zu nutzen, ist es erforderlich, dass du bei bestimmten Events Anfragen an EmergencyOS sendest.

Setup

Es ist Ihnen vollständig überlassen, von wo und wie Sie Anfragen an die API senden, solange sie der Dokumentation entsprechen.

Endpoints

Bevor Sie eine Anfrage an die API senden, müssen Sie Ihre Instance ID ermitteln. Dies ist einmalig pro Server/Script-Start erforderlich. Mit dieser Instance ID müssen Sie dann jede weitere Anfrage validieren.

Get your instance id

GET https://emergencyos.de/api/getInstance

With this endpoint you can get the InstanceID for your account with which all further requests must be signed

Headers

Name	Type	Description
API-KEY*	string	Your EmergncyOS API Key
INSTANCE-USERNAME*	string	Your EmergencyOS admin username
INSTANCE-PASSWORD*	string	Your EmergencyOS admin password

200: OK Success

{
    instanceId: number, // You instance id
}

203: Non-Authoritative Information Error while reqest

{
    string errorMessage //ErrorMessage with more information
}

Dieser Endpoint sollte aufgerufen werden, sobald ein Spieler eine Rechnung auf dem Server bezahlt hat. Falls die Rechnungs-ID mit einem Ticket verknüpft ist, wird dieses automatisch als "bezahlt" markiert.

Set a bill as payed in EmergencyOS

POST https://emergencyos.de/api/billPayed

Reports a paid invoice to EmergencyOS and if a ticket exists for this invoice, it will be marked as paid

Headers

Name	Type	Description
API-KEY*	string	Your EmergncyOS API key
INSTANCE-ID*	number	Your instance id

Request Body

Name	Type	Description
billId*	string	The id of the invoice

200: OK Reqest success

401: Unauthorized Not successfully authorized

400: Bad Request Error with the reqest

{
    string errorMessage // Contains more Info about why the reqest failed
}