04 / API
API-Dokumentation
Vom ersten Schlüssel und API-Aufruf bis zu Änderungsstreams und MCP.
Erste Schritte
- Erstellen Sie ein Konto per E-Mail und bestätigen Sie Ihre E-Mail-Adresse.
- Stellen Sie unter Mein Konto einen neuen Schlüssel aus. Der neue Schlüssel wird direkt nach der Ausstellung nur einmal angezeigt. Bewahren Sie ihn daher sicher auf.
- Rufen Sie mit dem folgenden Befehl die Quellenliste ab. Bewahren Sie die Quellenangabe aus der Antwort auf.
Testschlüssel erhaltenAPI-Schlüssel
curl 'https://api.ntriq.co.kr/std/v1/sources' \
-H "X-YAP-Key: $NTRIQ_API_KEY"Setzen Sie beim Aufruf aus Code mit der Python-Standardbibliothek urllib den User-Agent-Header selbst (zum Beispiel your-app/1.0). Ohne ihn wird die Anfrage mit 403 blockiert. requests, httpx und curl funktionieren unverändert.
Öffentliche und authentifizierte APIs
In OpenAPI bestätigte Gateway-Routen stehen neben konkreten Aufrufen aus dem Integrationsvertrag. Einzelne Standard-API-Pfade sind im aktuellen Gateway-OpenAPI nicht separat definiert.
| OpenAPI-Route | Aufruf laut Integrationsvertrag | Zugriff |
|---|---|---|
/public/{path} | GET /public/v1/catalog · GET /public/v1/stats | Ohne Schlüssel · Metadaten und Bestände |
/std/{path} | GET /std/v1/sources · GET /std/v1/sources/{slug} · GET /std/v1/health | Schlüssel erforderlich · L0-Test möglich |
/std/{path} | GET /std/v1/changes | Schlüssel erforderlich · Testantworten bis 20 Datensätze |
/std/{path} | GET /std/v1/things · GET /std/v1/things/{id} | Schlüssel erforderlich · ab L1 kostenpflichtig |
/mcp | POST /mcp | Bearer-Schlüssel · tarifabhängige Tools |
/lawink/{path} | POST /lawink/api/v1/citations/verify | Schlüssel erforderlich · kostenpflichtige Zitatprüfung |
Authentifizierung
Kunden-APIs akzeptieren X-YAP-Key oder Authorization: Bearer. Verwenden Sie nicht X-API-Key. Leiten Sie authentifizierte Browseranfragen über Ihren Server. Öffentlicher Katalog und Spezifikationen benötigen keinen Schlüssel.
Was ein Tarif kauft
L0Standardisierte Quelle- Die offene Quelle wie veröffentlicht, mit angeglichenem Schema, Encoding und Datumsformat.
L1Normalisiert und verknüpft- Dubletten entfernt, Adressen und Rechtsträger verknüpft, Behördencodes vereinheitlicht, Historie verbunden.
L2Bewertung und Zusammenfassung- Klassifikation, Bewertungen und Zusammenfassungen, übergeben samt der Begründung dafür.
L3Eigene Pipeline- Aufbereitung nach Ihrem Schema, mit eigenen Feldern und eigenem Aktualisierungstakt.
Quellenangaben in Antworten
Zeigen Sie meta.attribution aus Datenantworten unverändert in Ihrer Oberfläche an. Beachten Sie attribution_text und Lizenzbedingungen jeder Quelle.
Änderungsstreams und Cursor
Setzen Sie since auf einen ISO-8601-Zeitstempel. Übergeben Sie next_cursor URL-kodiert als cursor für die nächste Seite und behalten Sie since und Filter bei. Stoppen Sie bei fehlendem next_cursor oder leeren Ergebnissen. Testschlüssel erlauben maximal limit=20.
curl 'https://api.ntriq.co.kr/std/v1/changes?since=2026-09-01T00%3A00%3A00Z&limit=5' \
-H "Authorization: Bearer $NTRIQ_API_KEY"MCP-VerbindungIn Vorbereitung
Das ist noch in Vorbereitung. Den Termin geben wir in dieser Dokumentation bekannt.
Konfigurieren Sie die /mcp-Adresse und den Bearer-Schlüssel in einem Streamable-HTTP-Client. Beginnen Sie mit initialize. Der Testzugang unterstützt L0-Werkzeuge und die Suche in öffentlichen Quellen.
14 MCP-Tools
Sechs Standard- und acht Recherche-Tools, mit dem Gateway-Register abgeglichen. Auch Recherche-Aufrufe erfordern einen Schlüssel.
| Tool | Zweck | Zugriff |
|---|---|---|
list_sources | Quellenliste | Schlüssel erforderlich · L0-Test möglich |
get_source | Quellendetails | Schlüssel erforderlich · L0-Test möglich |
std_health | Erfassungsstand der Standardebene | Schlüssel erforderlich · L0-Test möglich |
get_changes | Änderungsstrom | Schlüssel erforderlich · Testantworten bis 20 Datensätze |
search_things | Suche nach Standarddatensätzen | Schlüssel erforderlich · ab L1 kostenpflichtig |
get_thing | Einzelner Standarddatensatz | Schlüssel erforderlich · ab L1 kostenpflichtig |
wikipedia_search | Wikipedia | Quellenrecherche · Testschlüssel möglich |
pubmed_search | PubMed | Quellenrecherche · Testschlüssel möglich |
semantic_scholar_search | Semantic Scholar | Quellenrecherche · Testschlüssel möglich |
gdelt_search | GDELT | Quellenrecherche · Testschlüssel möglich |
hackernews_search | Hacker News | Quellenrecherche · Testschlüssel möglich |
npm_package | npm | Quellenrecherche · Testschlüssel möglich |
pypi_package | PyPI | Quellenrecherche · Testschlüssel möglich |
crt_sh | crt.sh | Quellenrecherche · Testschlüssel möglich |
curl 'https://api.ntriq.co.kr/mcp' \
-H "Authorization: Bearer $NTRIQ_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json, text/event-stream' \
--data '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"ntriq-example","version":"1.0.0"}}}'Senden Sie nach der Initialisierungsantwort notifications/initialized. Gibt der Server Mcp-Session-Id zurück, senden Sie diesen Header und die ausgehandelte MCP-Protocol-Version bei weiteren Anfragen mit.
API-Testumgebung
Erkunden Sie den Katalog ohne Schlüssel oder fragen Sie mit einem Kundenschlüssel Quellen und aktuelle Änderungen ab.
Anfrage
Beginnen Sie mit dem Quellenkatalog. Kein Schlüssel erforderlich.
JSON-Antwort
Prüfen Sie die erste Antwort
Starten Sie eine Anfrage. Hier sehen Sie die Antwort mit Feldern und Quellenangabe.
Prüfung juristischer Zitate
Eine kostenpflichtige API zur Prüfung juristischer Zitate in Dokumenten über /lawink/api/v1/citations/verify. Eingabeformat und Leistungsumfang werden bei der Einführung bestätigt. Vollständige Bewertungen und individuelle Felder sind nicht Teil öffentlicher Beispiele.