Mit der PICO-API kannst du dokumentierte Funktionen in eigene Abläufe integrieren, beispielsweise um Website-Statistiken in einer internen Auswertung zu verwenden. Beginne mit einer kleinen lesenden Anfrage. So prüfst du Authentifizierung, Parameter und Antwort, bevor du schreibende Vorgänge einrichtest.
Voraussetzungen und sichere Ablage
Dein Tarif muss API-Zugriff enthalten. Prüfe dieses Merkmal unter Tarif. Im Kontomenü gibt es außerdem den Bereich API mit dem API-Schlüssel. Gib diesen Schlüssel nur an berechtigte Personen und Anwendungen weiter. Er gehört weder in öffentliche Webseiten noch in Screenshots, veröffentlichte Beispielprogramme oder frei zugängliche Protokolle.
Nutze für eine eigene Integration eine geschützte serverseitige Konfiguration. Der Wert DEIN_API_SCHLUESSEL in dieser Anleitung ist nur ein Platzhalter. Er ist kein funktionierender Schlüssel und soll in einer echten Anfrage durch deinen vertraulich gespeicherten Wert ersetzt werden.
Schritt für Schritt: die erste Anfrage vorbereiten
- Öffne die API-Dokumentation. Verwende den Eintrag API-Dokumentation im Fußbereich von PICO. Wähle dort den Bereich für die Daten, die du abrufen möchtest.
- Übernimm Methode und Endpunkt. Lies die Angaben zum konkreten Vorgang, beispielsweise Alle abrufen oder Einzelnen Eintrag abrufen. Übernimm Basis-URL, Endpunkt und Methode aus der aktuellen Dokumentation; konstruiere keine Adresse aus dem Namen einer Dashboard-Seite.
- Setze die Authentifizierung. Die dokumentierten API-Endpunkte verwenden Bearer-Authentifizierung. Übermittle den Schlüssel im dafür vorgesehenen Header:
Authorization: Bearer DEIN_API_SCHLUESSEL
- Prüfe die Parameter. Unterscheide Erforderlich und Optional. Beachte Datentypen, erlaubte Werte und die Bedingungen unter Verfügbar, wenn. Verwende nur Parameter, die für den gewählten Endpunkt dokumentiert sind.
- Lege einen eindeutigen Zeitraum fest. Bei Website-Statistiken sind
start_dateundend_dateals Datum im FormatY-m-dbeschrieben. Ein Beispiel ist2026-09-01bis2026-09-30. Andere Filter können Zeitangaben im FormatY-m-d H:i:serwarten; verwechsle diese Formate nicht. - Sende zunächst eine lesende Anfrage. Prüfe HTTP-Status und Antwortinhalt gemeinsam. Vergleiche die Struktur mit der Beispielantwort und kontrolliere Website, Zeitraum und Kennzahl.
- Baue die Integration schrittweise aus. Berücksichtige bei Listen die dokumentierte Seitennummer und Ergebnisanzahl. Die Dokumentation nennt UTC als Zeitzone der Ergebnisse, sofern nicht anders angegeben. Berücksichtige diesen Hinweis, bevor du API-Ergebnisse mit Ansichten im Dashboard vergleichst.
Beispiel: ein interner Bericht für example.com
Du möchtest die Statistiken von example.com für einen abgeschlossenen Monat übernehmen. Wähle den dokumentierten Statistikabruf, übergib die dort verlangte Website-Zuordnung sowie ein ausdrückliches Start- und Enddatum. Vergleiche das Ergebnis mit demselben Zeitraum und derselben Kennzahl in PICO. Der Website-Host ist dabei dein Auswertungsgegenstand, nicht automatisch die Basis-URL der API.
Statuscodes richtig einordnen
| Status | Bedeutung und nächster Schritt |
|---|---|
| 200 | Die Anfrage war erfolgreich. Prüfe trotzdem, ob der Antwortinhalt zu deinem gewünschten Abruf passt. |
| 400 | Parameter fehlen oder sind ungültig. Vergleiche Pflichtfelder, Datentypen und erlaubte Werte. |
| 401 | Der Schlüssel fehlt oder ist ungültig. Prüfe den Bearer-Header, ohne den Schlüssel öffentlich auszugeben. |
| 404 | Die angeforderte Ressource wurde nicht gefunden. Prüfe Endpunkt und übergebene Zuordnung. |
| 429 | Das Anfragelimit wurde überschritten. Warte und reduziere die Abfragefrequenz. |
| 500 | Ein interner Serverfehler ist aufgetreten. Prüfe den Vorgang später erneut und bewahre eine bereinigte Fehlerbeschreibung auf. |
Erfolgskontrolle und Schlüsselwechsel
Deine erste Integration funktioniert, wenn die erwarteten Daten für die richtige Website zurückkommen und der Schlüssel in keiner öffentlichen Ausgabe erscheint. Eine Meldung über fehlenden API-Zugriff kann zusätzlich auf die Tarifvoraussetzung hinweisen.
API-Schlüssel neu generieren ist ein gesonderter Eingriff. Plane vorher, welche Integrationen den vorhandenen Schlüssel verwenden, und aktualisiere ihre geschützte Konfiguration anschließend passend. Verwende diese Funktion nicht als beliebigen Testknopf. Eine private Webhook-URL für ein Webhook-Ziel ist wiederum ein eigener Mechanismus; behandle sie ebenfalls vertraulich und verwechsle sie nicht mit dem Bearer-Schlüssel.