Dokumentation

API Reference

Die megaschrift-API ist nach dem REST-Standard organisiert. Unsere API hat vorhersehbare ressourcenorientierte URLs, akzeptiert formularcodierte Anfragerümpfe, gibt JSON-codierte Antworten zurück und verwendet standardmäßige HTTP-Antwortcodes, Authentifizierung und Verben.

Authentifizierung

Die megaschrift-API verwendet API-Schlüssel zur Authentifizierung von Anfragen. Sie können Ihren API-Schlüssel unter dem Menüpunk 'Einstellungen' anzeigen und verwalten. Ihre API-Schlüssel sind mit vielen Privilegien verbunden, also achten Sie darauf, sie sicher aufzubewahren! Geben Sie Ihre geheimen API-Schlüssel nicht in öffentlich zugänglichen Bereichen wie GitHub, clientseitigem Code usw. weiter. Die Authentifizierung bei der API erfolgt über einen Query Parameter (?token=). Sie müssen kein Passwort angeben. Alle API-Anfragen müssen über HTTPS erfolgen. Aufrufe, die über einfaches HTTP erfolgen, schlagen fehl. API-Anfragen ohne Authentifizierung schlagen ebenfalls fehl.

$ curl https://api.megaschrift.com/v1/signature-requests?token=IHR-GEHEIMER-TOKEN

Mögliche Fehlercodes

megaschrift verwendet herkömmliche HTTP-Antwortcodes, um den Erfolg oder Misserfolg einer API-Anfrage anzuzeigen. Im Allgemeinen: Codes im 2xx-Bereich zeigen einen Erfolg an. Codes im 4xx-Bereich weisen auf einen Fehler hin, der angesichts der bereitgestellten Informationen nicht auftrat (z. B. wurde ein erforderlicher Parameter ausgelassen, eine Aufladung schlug fehl usw.). Codes im Bereich 5xx weisen auf einen Fehler bei den Servern von megaschrift hin (diese sind selten).

Signaturanfrage erstellen

$ curl -d "@data.txt" -X POST https://api.megaschrift.com/v1/signature-request/simple?token=IHR-GEHEIMER-TOKEN