pr0gramm-API für Laravel
Für eigene Projekte rund um pr0gramm werden immer wieder ähnliche Zugriffe benötigt: Informationen zu Nutzern und Beiträgen lesen, Kommentare verarbeiten oder auf Nachrichten zugreifen. Der Laravel-Wrapper bündelt die Anbindung an die API in einem PHP-Paket.
Er ist eine eigenständige Integration und kein offizielles Produkt von pr0gramm. Die Schnittstelle ist nach Bereichen gegliedert: User, Post, Tag, Comment, Contact, Inbox und Profile. So bleibt im aufrufenden Code erkennbar, zu welchem Teil der Plattform eine Anfrage gehört.
Zugriffe über eine Facade
Das Paket wird mit Composer installiert:
composer require tschucki/laravel-pr0gramm-api
Über die Facade lässt sich anschließend beispielsweise der aktuell angemeldete Nutzer abfragen:
$currentUser = Pr0grammApi::User()->me();
Für kontobezogene Endpunkte ist eine Anmeldung erforderlich. Das Paket bietet dafür Login und Logout und verwaltet die zugehörige Sitzung. Die Dokumentation beschreibt außerdem die Verwendung eines bereits vorhandenen Cookies sowie die unterschiedlichen Voraussetzungen von regulären und Bot-Konten.
Ein gemeinsamer Unterbau
Der Wrapper wird auch von weiteren veröffentlichten Projekten verwendet. Der pr0gramm Notification Channel setzt darauf auf, um Nachrichten aus Laravel zu versenden. Der TLDR-Bot nutzt das Paket für seine Verbindung zur Plattform.
Dokumentation
Das Repository enthält Beispiele für die einzelnen Bereiche und Hinweise zur Anmeldung.