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 Softwaresystem 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. (z.B. Dass das Loginsystem mit dem Ingameserver, sowie mit dem Forum und dem Control Panel verbunden sind. Dadurch müsst ihr nur einen Account erstellen)

Wieso sind APIs so wertvoll?

• Sie ermöglichen, Entwicklern aus aller Welt, ihre eigenen Programmfeatures mit anderen 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 einem API-Secret von der Projektleitung erfolgen.
• Dieser ist für die Projektleitung eine Sicherheitsmaßnahme und wird nur bereitgestellt, so lange der Zugang sinnvoll benötigt wird. (z.B. Prüfungsprogramme oder Mitgliederlisten)

Abfragewerte

Auf Vio Reallife lassen sich folgende Inhalte abfragen:

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...)