Entwickler-Dokumentation

REST API und Embed-Status für externe Integrationen

Für Teams, die namensschild.io über ihren privaten API-Key in eigene Backends integrieren oder den Stand des künftigen Embed-Vertrags transparent nachvollziehen möchten.

Heute produktiv nutzbar

Die Public API unterstützt aktuell Discovery von Vorlagen und Papierpresets, synchrone PDF-Erzeugung aus CSV mit explizitem Slot-Mapping, Credits-Abfragen, Exportlisten und den erneuten Download fertiger Exporte.

POST/v1/generateCSV hochladen und direkt ein PDF erhalten GET/v1/creditsGuthaben und Auto-Refill lesen GET/v1/templatesVerfügbare Vorlagen und Pflicht-Slots laden GET/v1/templates/{id}Vorlagen-Details und Status lesen GET/v1/paper-presetsPapierpresets und Layout-Vorgaben laden GET/v1/paper-presets/{id}Layout eines Papierpresets lesen GET/v1/exportsExporte eines Accounts filtern und paginieren GET/v1/exports/{id}Vorhandenen Export erneut herunterladen

API-Stand auf einen Blick

Dokumentierte Endpunkte: 8
Basis-URL: https://api.namensschild.io
Authentifizierung: Privater API-Key
Fehlerformat: JSON · docUrl

Maschinenlesbare Discovery

Neben der menschlichen API-Referenz veröffentlicht die API-Domain zusätzlich einen stabilen Satz maschinenlesbarer Discovery-Artefakte für SDKs, Automatisierungen und KI-Tools.

Root Discovery JSONhttps://api.namensschild.io/

Maschinenlesbarer Einstieg mit Basis-URL, Auth-Hinweisen, Discovery-Artefakten und den wichtigsten Ressourcen.

OpenAPI 3.1https://api.namensschild.io/openapi.json

Kanonische Maschinenbeschreibung der Public API. /openapi/v1 bleibt als Kompatibilitätsalias erreichbar.

llms.txthttps://api.namensschild.io/llms.txt

Kuratierter KI-Hinweis für Agenten, der auf OpenAPI, Docs und die wichtigsten Endpunkte verweist.

API-Kataloghttps://api.namensschild.io/.well-known/api-catalog

Standardisierte Discovery im Linkset-Format mit service-desc-, service-doc- und service-meta-Verweisen.

Transparenz zum Embed

Für browserseitige Widgets gibt es derzeit noch keinen öffentlichen, Secret-safe Vertragsstand. Die Seite Embed integrieren erklärt klar, was heute möglich ist und wo die Sicherheitsgrenze liegt.

Interne Debug-Hinweise

Setup-, Bootstrap- und Verifikationsschritte für interne Entwickler:innen liegen bewusst getrennt von der Integrationsdokumentation.

Internes Debugging öffnen →