Daten-Connector-Leitfaden & API-Dokumentation

Erste Schritte

Generieren Ihres API-Tokens

1. Navigieren Sie zum Abschnitt "Data Connector" in Ihren Einstellungen.
2. Klicken Sie auf die Schaltfläche "Neues Token generieren".
3. Kopieren Sie das generierte Token mit der Schaltfläche "Token kopieren".

Verwenden Ihres API-Tokens

Fügen Sie das API-Token in den Header Ihrer API-Anfragen ein:

Authorization: Bearer IHR_API_TOKEN

Stellen Sie sicher, dass Sie HTTPS für alle API-Aufrufe verwenden, um Ihr Token zu schützen. Erfolgreiche Anfragen geben den Statuscode 200 OK zurück.

Widerrufen und Regenerieren von Tokens

Wenn Sie glauben, dass Ihr Token kompromittiert wurde, navigieren Sie zurück zum Abschnitt "Data Connector".

• Klicken Sie auf "Neues Token generieren", um das aktuelle Token zu widerrufen und ein neues zu generieren oder die Verwendung des Tokens zu deaktivieren.
• Aktualisieren Sie Ihre Anwendungen mit dem neuen Token.

Ratenbegrenzung

Die API erlaubt bis zu 20 Anfragen pro Minute, 200 Anfragen pro Stunde und 1000 Anfragen pro Tag. Wenn Sie dieses Limit überschreiten, erhalten Sie einen Fehler 429 Too Many Requests. Warten Sie eine Minute, bevor Sie weitere Anfragen stellen.

Best Practices für die Sicherheit

• Teilen Sie Ihr API-Token niemals öffentlich.
• Speichern Sie Ihr API-Token an einem sicheren Ort, wie z.B. Umgebungsvariablen oder einem Secrets-Manager.
• Rotieren Sie Ihr API-Token regelmäßig für eine verbesserte Sicherheit.

Fehlerbehebung bei häufigen Problemen

• Ungültiges Token: Stellen Sie sicher, dass das Token korrekt kopiert und in den Anfrage-Header eingefügt wurde.
• Token abgelaufen: Generieren Sie ein neues Token, wenn das aktuelle abgelaufen ist.

Anforderungs-Endpunkt - Abfallprotokolle

GET https://web.positivecarbon.com/api/positive_carbon_waste_logs

Header & Metadaten:

• IHR_API_TOKEN
• totalItems: die Gesamtanzahl der Abfallprotokoll-Ereignisse
• currentPage: die aktuelle Seite der Elemente – wird verwendet, um durch Seiten von Elementen zu blättern
• totalPages: die Anzahl der Seiten, die durchgeblättert werden können
• pageSize: die Anzahl der auf der aktuellen Seite zurückgegebenen Abfallprotokoll-Ereignisse/Elemente. Standard = 100, Anfragen sind auf 100 Elemente pro Seite begrenzt.

Zurückgegebene Felder:

Feld	Beschreibung
Site Name	Der Name der Site
Client Site ID	Die ID der Site des Kunden (falls angegeben und in das Positive Carbon-System hochgeladen)
Timestamp	Der Zeitpunkt des Abfallprotokolls, zu dem es aufgetreten ist
Gerät / Monitor Name	Der Monitor/Überwachungsbereich der Abfallerfassung innerhalb der Site. Es kann nur eine Kamera und ein Monitor vorhanden sein.
Lebensmittel	Das identifizierte Lebensmittel im Abfallprotokoll
Lebensmittelkategorie	Die Kategorie, zu der das Lebensmittel gehört
Lebensmittelunterkategorie	Die Unterkategorie, zu der das Lebensmittel gehört
Trimmings-Flag	Ein Indikator, ob das entsorgte Lebensmittel Abfallstücke waren
Gewicht (KG)	Das Gewicht des entsorgten Lebensmittels in kg
Abfallkosten (EUR)	Der berechnete Eurobetrag des Abfallereignisses
Abfallemissionen (CO2eq)	Die berechnete CO2-Äquivalente des Abfallereignisses in kg
Wasserverbrauch	Die berechnete Wassermenge des Abfallereignisses in Litern
Letzter Kommentar	Der letzte Kommentar eines Benutzers auf der Seite des Positive Carbon-Image-Feeds