Eigene Software verbinden Sie auf zwei Wegen mit OAKMONT. Entweder Sie rufen die API mit einem Schlüssel auf, oder OAKMONT ruft Ihren Endpunkt auf, wenn in Ihrem Konto etwas passiert. Beides richten Sie unter Organisation ein.
Einen API-Schlüssel erstellen#
- Öffnen Sie Organisation und gehen Sie zum Abschnitt Entwickler-API.
- Tragen Sie unter Schlüssel erstellen im Feld Name ein, wo der Schlüssel verwendet wird, und drücken Sie Schlüssel erstellen.
- Die Karte Ihr neuer API-Schlüssel zeigt den vollständigen Schlüssel. Drücken Sie Kopieren und legen Sie ihn sofort sicher ab. Er wird einmal angezeigt und danach nie wieder.
Danach zeigt die Liste von jedem Schlüssel nur ein kurzes Präfix sowie den Zeitpunkt der Erstellung und der letzten Verwendung. Ein Konto kann bis zu 10 aktive Schlüssel haben.
Der erste Aufruf#
Senden Sie den Schlüssel als Bearer-Token im Authorization-Header. Der Bereich Ihr erster Aufruf auf derselben Seite liefert einen fertigen Befehl, der eine Seite bewertet und die Befunde als JSON zurückgibt. Die API deckt Barrierefreiheits-Scans und Preisangebote ab, und API-Dokumentation öffnet die vollständige Referenz.
Tokens#
Oben im Abschnitt stehen drei Kacheln: In diesem Monat verbrauchte Tokens, Tokens pro Monat und Verbleibend. Jeder Aufruf zählt gegen das Kontingent. Sind die Tokens des Monats verbraucht, werden Aufrufe bis zum Beginn des nächsten Monats abgelehnt, es sei denn, Sie kaufen ein Token-Paket oder wechseln in einen größeren Plan.
Einen Schlüssel widerrufen#
Drücken Sie das Papierkorb-Symbol in der Zeile eines Schlüssels und bestätigen Sie mit Widerrufen. Alles, was diesen Schlüssel nutzt, funktioniert sofort nicht mehr, und das lässt sich nicht rückgängig machen. Widerrufene Schlüssel bleiben in der Liste und sind entsprechend markiert.
Ausgehende Webhooks#
Scrollen Sie im Abschnitt Integrationen zu Ausgehende Webhooks. Tragen Sie unter Endpunkt-URL eine öffentliche https-Adresse ein und drücken Sie Webhook hinzufügen. Das Signaturgeheimnis für diesen Endpunkt erscheint ein einziges Mal. Kopieren Sie es, bevor Sie Fertig drücken. Von da an sendet OAKMONT signierte JSON-Ereignisse an diese Adresse, etwa wenn ein Auftrag abgeschlossen ist oder eine überwachte Seite sich verschlechtert. Jede Zustellung trägt einen Header X-OAKMONT-Signature, den Sie mit dem Geheimnis prüfen, dazu den Namen des Ereignisses und einen Zeitstempel in eigenen Headern.
Zustellungen prüfen#
Test senden in der Zeile eines Webhooks sendet ein Testereignis und meldet das Ergebnis. Die Kennzeichnung neben der Adresse zeigt, wie die letzte Zustellung verlaufen ist, mit dem HTTP-Status, den Ihr Server zurückgegeben hat. Private Adressen und Loopback-Adressen werden abgelehnt. Um Zustellungen an einen Endpunkt zu beenden, drücken Sie das Papierkorb-Symbol in seiner Zeile und bestätigen mit Entfernen.