Entwicklerportal

API-Dokumentation

Integrieren Sie unveränderliche Beweissicherung direkt in Ihre Systeme. RESTful, schnell und sicher.

Authentifizierung & Endpunkte

Zugriff auf die Cindermark API erfolgt über HTTPS. Alle Anfragen müssen einen gültigen API-Schlüssel im Header enthalten.

Basis-URL

          https://api.cindermark.io/v1
        

Authentifizierung

Übergeben Sie Ihren Schlüssel im Authorization Header:

          Authorization: Bearer <IHR_API_SCHLÜSSEL>
        

Wichtige Ressourcen

POST /hash/create

Erstellt einen neuen SHA-256 Hash und verankert ihn in der Blockchain.
GET /hash/verify/{id}

Überprüft die Integrität eines Dokuments basierend auf der ID.
GET /audit-log

Ruft das vollständige Protokoll der letzten 30 Tage ab.

Code-Beispiele

So einfach integrieren Sie Cindermark in Ihre Anwendung.

Python

          import requests

          headers = {

            "Authorization": "Bearer API_KEY"

          }

          response = requests.post(

            "https://api.cindermark.io/v1/hash/create",

            headers=headers,

            json={"content": "Dokument-Text"}

          )

          print(response.json())

JavaScript (Node.js)

          const axios = require('axios');

          const hashDoc = async () => {

            const res = await axios.post(

              'https://api.cindermark.io/v1/hash/create',

              { content: 'Dokument-Text' },

              { headers: { Authorization: 'Bearer API_KEY' } }

            );

            console.log(res.data);

          }

cURL

          curl -X POST https://api.cindermark.io/v1/hash/create \

            -H "Authorization: Bearer API_KEY" \

            -H "Content-Type: application/json" \

            -d '{"content": "Dokument-Text"}'

Rate Limits & Best Practices

Um die Stabilität des Netzwerks zu gewährleisten, gelten folgende Limits pro API-Schlüssel:

100 Requests pro Minute
5.000 Requests pro Tag (Free Tier)

Empfehlungen

Verwenden Sie exponentiellen Backoff bei 429 Too Many Requests Antworten. Batch-Verarbeitung wird für große Dokumentenmengen empfohlen.

Changelog & Versionierung

Wir halten die API stabil, entwickeln aber stetig weiter. Aktuelle Version: v1.4.2

v1.4.2 — 12. Okt 2023

Bugfix beim Batch-Upload von PDF-Dateien > 50MB.

v1.4.0 — 28. Sep 2023

Neue Endpunkte für Webhook-Integrationen und E-Mail-Benachrichtigungen.

v1.3.5 — 15. Aug 2023

Optimierung der Hash-Generierungszeit um 20%.

Brauchen Sie technische Hilfe?

Unser Entwickler-Support ist von Mo-Fr, 09:00 - 17:00 Uhr erreichbar. Fragen zur Implementierung oder API-Spezifikationen?

Zum Support-Forum