Demo buchen DataCollect Dokumentation 1.0
Über dieses Dokument – Hier klicken
Kontaktinformationen – Hier klicken
Fehlerbehandlung – Hier klicken
Änderungsverlauf – Hier klicken
Über dieses Dokument
Dieses Dokument soll einen umfassenden Überblick über die DataCollect API und deren Integration in Verarca geben.
Das folgende Dokument bietet eine Anleitung zum Einstieg in die Datenübermittlung und beschreibt den Ablauf, der dabei eingehalten werden sollte.
Es ist wichtig, dass du das gesamte Dokument liest und alle Fragen vor Beginn der Integration an rene@verarca.com sendest.
Kontaktinformationen
Bitte wende dich bei Fragen an folgende Kontakte:
Technischer Support: rene@verarca.com
Allgemeine Anfragen: contact@verarca.com
Einführung
Die erste Integration mit unserer API erfolgt durch ein Konto auf Verarca.com. Um Zugang zu einem Testkonto zu erhalten, kontaktiere bitte rene@verarca.com.
Die DataCollect API besteht aus zwei Umgebungen – Staging und Produktion – mit den folgenden Endpunkten:
Staging: https://staging.datacollect.verarca.com/swagger
Produktion: https://datacollect.verarca.com/swagger
Beide Umgebungen führen verschiedene Sicherheitsprüfungen durch, um die Plattform stabil zu halten. Eine davon ist die Ratenbegrenzung. Wenn du auf Probleme stößt, wende dich bitte an den technischen Support.
Die API verwendet Versionierung. Es wird dringend empfohlen, immer die angegebenen Versions-Endpunkte zu nutzen, um Unterbrechungen zu vermeiden. Die aktuelle Version ist in der bereitgestellten Swagger-Dokumentation sichtbar.
In den folgenden Kapiteln wird beschrieben, wie Daten in DataCollect für spezifische Datenbereiche importiert werden.
Buchhaltung
Die Basisdaten von Verarca stammen aus ERP-/Buchhaltungssystemen und dienen der Berechnung von CO₂-Emissionen auf Grundlage verschiedener Einkäufe und Rechnungen.
Der folgende Ablauf sollte stets eingehalten werden:
1. Der Kunde erhält ein Token von Verarca.com.
2. Der Kunde gibt das Token in die Client-Anwendung (Integrationspartner) ein.
3. Nach Eingabe des Tokens in die Client-Anwendung sollte diese eine vollständige Übersicht über den Kontenplan übermitteln.
4. Nachdem der Kontenplan an DataCollect gesendet wurde, muss der Kunde in Verarca.com die relevanten Konten markieren.
– Dies dient dazu, nur CO₂-relevante Daten zu erfassen.
5. Täglich sollte die Client-Anwendung folgende Daten an DataCollect übermitteln:
-
- Abrufen, welche Konten in Verarca.com aktiviert wurden: /api/Accounts/Enabled
- Erstellen/Aktualisieren des Kontenplans: /api/Accounts
- Erstellen/Aktualisieren von Buchungseinträgen: /api/AccountEntries
- Hochladen/Anhängen von Dokumenten an Buchungseinträge: /api/Documents
Bei der ersten Synchronisierung sollte die Integration immer Daten für das laufende Jahr + das Vorjahr senden. Danach täglich alle Aktualisierungen/neuen Daten.
Beim Übermitteln von Buchungseinträgen muss der Typ des jeweiligen Eintrags angegeben werden. Dies geschieht über den Parameter “type”. DataCollect unterstützt folgende Formate:
Supplier = Rechnung vom Verkäufer an den Käufer
Payment = Zahlung an den Verkäufer
Credit = Gutschrift vom Verkäufer
Fehlerbehandlung
Wenn bei der Nutzung der DataCollect API ein Fehler auftritt, gibt die API ein JSON-Ergebnis wie das folgende zurück:
Wenn du Unterstützung benötigst, sende bitte die errorId an den technischen Support, um eine schnelle Bearbeitung zu ermöglichen.
Änderungsverlauf
| Datum | Änderungen | Typ |
