System: Breadfish RP API
Entwickelt von: Ben
Besonderer dank geht an: Adam_Edwards, Jan, Giraffe für Anregungen, Vertestung und Fehlermeldungen
Kommentar: API für diverse Funktionen von Breadfish RP
TL;DR: API v2, RESTful, Dokumentation + API-Design, API-Keys gibt's im Ticket-System
Hallo Leute,
es gibt bereits seit längerem kleinere vereinzelte APIs für Breadfish RP. So nutzen Giraffe, Adam und Jan bereits seit längerem eine API, um Private Nachrichten zu schreiben. Am Grundstücks-System (Vermessungs-System) hängt ebenfalls eine API, die Giraffe fleißig nutzt.
Mit dem Hinzukommen einer komplett neuen API, die ich an anderer Stelle noch mal genauer erläutern möchte, habe ich mich entschlossen, die bisherige PN-API ebenfalls auf ein neues Level zu heben. Diese beachtet nun nämlich auch die Filter-Regeln eurer Postfächer.
Alle APIs existieren als ein einziges System. Jeder Nutzer kann einen API-Key erhalten, der für die verschiedenen API-Teile freigeschaltet wird. Diese API-Keys können über unser Ticketsystem mit Auswahl des entsprechenden Themas beantragt bzw. auf neue Berechtigungen erweitert werden. Die aktuellen API-Keys für die PN-API bleiben bestehen.
Die API ist im RESTful Design gestaltet und damit mehr oder weniger "Industriestandard". Ich gehe davon aus, dass die Dokumentation Anwendern mit genügend Kompetenz ausreichen muss. Das B:RP-Team leistet daher keinen direkten Support bzw. Coding-Hilfe zur API. Dafür fehlt uns schlichtweg die Zeit. Bugmeldungen oder Anregungen sind natürlich trotzdem gerne gesehen.
Die Dokumentation und das API-Dokumentation könnt ihr in diesem Swagger-Dokument abrufen. Wenn ihr irgendwelche Anregungen zu Erweiterungen habt, könnt ihr auch gerne das dortige API-Design bearbeiten und mir dann schicken. Dann kann ich bei Bedarf das Design direkt umsetzen.
Viele Grüße
Ben