StateV vAPI
Die vAPI stellt Daten des eigenen Charakters und seiner Firmen für externe Anwendungen bereit. Hier findest du Authentifizierung, Berechtigungen, Endpunkte und Response-Strukturen an einem Ort.
Einstieg¶
Jeder Request verwendet die Basis-URL:
Du benötigst einen API-Key aus dem VNET und sendest ihn als Bearer-Token:
Authentifizierung einrichten API-Referenz öffnen
Bereiche¶
| Bereich | Inhalt |
|---|---|
| Firmen | Lager, Produktionen, Bankkonten, Transaktionen und Marktplatzdaten |
| Immobilien | Allgemeine Daten, Mieter, Zimmer, Konten und Transaktionen |
| Page Options | Freie Datenslots für eigene Anwendungen und Firmenwebseiten |
| Embedded VAPI | Premium-Funktionen für Webseiten im StateV-Tablet-Browser |
Grundregeln¶
- Ein API-Key gehört zu einem Charakter.
- Endpunkte liefern nur Daten, auf die dieser Charakter zugreifen darf.
- Scopes begrenzen den Zugriff eines API-Keys zusätzlich.
- Fehler werden mit einem passenden HTTP-Statuscode und einer Fehlermeldung beantwortet.