Vio-API

Was ist eine API?

• Eine API ist eine Programmierschnitstelle (Application Programming Interface) mit der sich Daten aus der Vio-Datenbank abfragen lassen.
• Die Api wird von einem Sofrtwaresystem bereitgestellt damit andere fremde Programme, bestimmte Teile dieses Softwaresystems für sich verwenden können.
• Eine Schnitstelle ist ein Teil eines Systems, dass der Kommunikation dient.
• Sie ermöglicht es 2 voneinander unbekannten Systemen miteinander zu Kommunizieren. (bsp. Das Loginsytem das Ingame sowie mit Forum und Controlpanel verbunden ist dadurch müsst ihr nur einen Account erstellen)

Wieso sind APIs so wertvoll?

• Sie ermöglichen es Entwicklern aus aller Welt, ihre eigenen Programmfeatures mit andern Programmen zu teilen
• Bereits gelöste Probleme müssen nicht wieder neu gelöst werden
• Mehrere APIs von verschiedenen Softwaresystemen können zusammen dazu verwendet werden, ganz neue Lösungen bereitzustellen.

Einschränkungen von APIs

• Die nutzung der Server API kann nur mit einen API-Key und ein API-Secret von der Projektleitung erfolgen.
• Dieser ist für die Projektleitung eine Sicherheitsmaßnahme und wird nur bereitgestellt solange diese sinvoll benötigt wird. (Prüfungsprogramme oder Mitgliederliste)

Mit dieser lassen sich folgende Inhalte abfragen:

Abfragewerte

players/"SPIELERNAME"

oder

factions/"FraktionsID"?expand=members(items)

Datenwert	Bedeutung
faction	Aktuelle Fraktion
factionRank	Fraktionsrang
lastFactionUninviteTimestamp	Letzter Uninvite
playerName	Spielername
lastFactionInviteTimestamp	Letzter Invite
gangRank	Rang in der Gang (1-5)
socialState	Sozialer Status
phoneNumber	Ingame Handynummer (sofern Online)
warns	Liste der Warns
playerID	Identifikationsnummer
playingTime	Spielzeit in Minuten
isOnline	Loginstatus
skin	SkinID
adminLevel	Anzeige des Adminlevels (0=Zivilist/Ticketsupporter, 1=Supporter...)