Beta REST API · JSON

Permaref
per API.

Archivierung und Zitation programmatisch: Bibliothekssysteme, Research Tools und eigene Anwendungen können die gesamte Permaref-Infrastruktur über eine einfache REST API nutzen.

API-Zugang anfordern Kontakt

curl · Beispiel

            # Quelle archivieren + zitieren

            curl https://api.permaref.de/v1/archive \

              -X POST \

              -H "Authorization: Bearer YOUR_KEY" \

              -d '{"url": "https://example.com/artikel",

                "format": "apa7"}'

            # Antwort (JSON)

            {

              "archive_url": "https://web.archive.org/...",

              "citation": "Autor, A. (2024). Titel...",

              "format": "apa7",

              "status": "archived"

            }

Endpunkte

API-Übersicht (Beta)

POST /v1/archive

URL archivieren & zitieren

Archiviert eine URL via Wayback Machine und gibt die fertige Zitation im gewählten Format zurück.

GET /v1/citations

Alle Zitationen abrufen

Gibt alle gespeicherten Zitationen des Accounts zurück, paginiert und filterbar nach Format und Datum.

GET /v1/citations/{id}

Einzelne Zitation

Ruft eine einzelne Zitation mit allen Metadaten, Archiv-URL und Ursprungs-URL ab.

POST /v1/bulk-archive

Batch-Archivierung

Bis zu 100 URLs in einem einzigen API-Call archivieren und zitieren. Ideal für Bibliothekssysteme.

GET /v1/monitor

Link-Rot-Status

Gibt den aktuellen HTTP-Status aller gespeicherten URLs zurück (200, 301, 404 etc.).

DELETE /v1/citations/{id}

Zitation löschen

Löscht eine Zitation und die zugehörigen Metadaten aus der Datenbank (Archiv auf Wayback bleibt erhalten).

Features

Was die API kann

API-Key Authentifizierung

Einfache Bearer-Token-Auth. Schlüssel können im Dashboard erstellt, rotiert und widerrufen werden.

9 Zitierformate

Alle Formate (APA 7, MLA 9, Chicago, DIN ISO 690, BibTeX, RIS u. a.) sind per API abrufbar.

Webhooks

Erhalte POST-Callbacks, wenn eine Archivierung abgeschlossen ist oder ein Link-Rot-Alert ausgelöst wird.

Bibliotheks-Tier

Unlimitierte API-Calls, dedizierter Support, SLA 99,5 %, SSO-Integration – für Universitätsbibliotheken.

DSGVO-konform

Alle Daten bleiben auf EU-Servern. Kein US-Transfer. Data Processing Agreement (DPA) auf Anfrage.

Rate Limits & Logs

Detaillierte Nutzungsstatistiken, Rate Limit Headers und vollständige Request-Logs im Dashboard.

Permarefper API.