Für detailliertere API-Dokumentation besuchen Sie bitte unsere Silktide API-Dokumentationsseite.
Diese Seite erklärt, wie Sie unsere API verwenden können, um hochrangige Statistiken über die Websites in Ihrem Silktide-Konto abzurufen.
Der häufigste Anwendungsfall für unsere API ist das Extrahieren von Daten zur Verwendung in den internen Berichtswerkzeugen Ihrer Organisation, wie Power BI oder Tableau.
Alle Anfragen an unsere API sollten authentifiziert werden, indem ein API-Schlüssel eines Silktide-Kontos verwendet wird. Unsere API ist RESTful und kommuniziert über JSON.
Um Ihren API-Schlüssel zu erhalten, kontaktieren Sie bitte Ihren Account Manager.
Authentifizierung einer Anfrage
Senden Sie Ihren API-Schlüssel als Abfrageparameter (?apiKey=YOUR_KEY) mit jeder Anfrage.
Wenn Ihr API-Schlüssel ungültig ist oder Sie keinen Zugriff auf die angeforderte Ressource haben, erhalten Sie die folgende Antwort:
{ "error": { "type": "Exception", "message": "Ungültiger API-Schlüssel", "properties": { "requiredPermission": null } }, "type": "AccessDenied"}API-Endpunkt
Methode: GET
Endpunkt: api.{regionId}.silktide.com/v1/websites/stats
Die {regionId} ist die Region, in der Ihr Konto gespeichert ist.
us für die USA.
eu für den Rest der Welt.
Beispiel einer API-Anfrage
curl https://api.us.silktide.com/v1/websites/stats?apiKey=YOUR_KEY
Beispiel einer API-Antwort
{ "websites": { "2": { "name": "Meine Hauptwebsite", "homeUrl": "https://www.example.com/", "websiteId": 2, "stats": { "wcag-20-a.score": { "label": "WCAG 2.0 A Bewertung", "value": 64.510262 }, "wcag-20-aa.score": { "label": "WCAG 2.0 AA Bewertung", "value": 59.042248 }, "wcag-20-aaa.score": { "label": "WCAG 2.0 AAA Bewertung", "value": 58.114101 }, "wcag-20.score": { "label": "Barrierefreiheit (WCAG 2.0) Bewertung", "value": 61.363632 }, "wcag-21-a.score": { "label": "WCAG 2.1 A Bewertung", "value": 64.510262 }, // ... und viele weitere Statistiken }, "sections": { "3": { "name": "Weinauswahl", "homeUrl": "https://www.example.com/wines", "sectionId": 3, "stats": { "wcag-20-a.score": { "label": "WCAG 2.0 A Bewertung", "value": 60.510262 }, "wcag-20-aa.score": { "label": "WCAG 2.0 AA Bewertung", "value": 54.042248 }, "wcag-20-aaa.score": { "label": "WCAG 2.0 AAA Bewertung", "value": 52.114101 }, "wcag-20.score": { "label": "Barrierefreiheit (WCAG 2.0) Bewertung", "value": 63.363632 }, "wcag-21-a.score": { "label": "WCAG 2.1 A Bewertung", "value": 68.510262 }, // ... und viele weitere Statistiken } } } } }}Antwortfelder
Jedes Ergebnis innerhalb des Schlüssels von Websites wird durch die Website-ID gekennzeichnet und enthält wichtige Informationen über die Website.
Dies beinhaltet das stats-Objekt, das die wichtigsten Statistiken für diese Website zum aktuellen Zeitpunkt zurückgibt.
Das sections-Objekt innerhalb einer website wird durch die Abschnitts-ID gekennzeichnet und enthält wichtige Informationen über den Abschnitt sowie ein weiteres stats-Objekt nur für diesen Abschnitt.
Jede Statistik enthält eine kurze Beschreibung, wofür sie verwendet wird.