SendPol Logo

    SendPol API-Dokumentation

    Integriere Peppol-Funktionen nahtlos in deine Anwendungen mit unserer leistungsstarken REST-API. Teste Endpunkte direkt aus dieser Dokumentation.

    Schnellnavigation

    Endpunkte
    Allgemein
    Konto
    Dokumente

    Erste Schritte

    Die SendPol API bietet eine einfache Möglichkeit, Dokumente an das Peppol-Netzwerk zu senden. Unsere RESTful API unterstützt verschiedene Formate und Integrationen.

    Basis-URL

    https://api.sendpol.com/

    API-Schlüssel-Authentifizierung

    Die SendPol API nutzt eine API-Schlüssel-Authentifizierung. Füge deinen API-Schlüssel zum X-API-Key-Header jeder Anfrage hinzu.

    Header-Format

    api-key: YOUR_API_KEY

    🔑 Mit deinem API-Schlüssel testen

    Gib hier deinen API-Schlüssel ein, um alle Endpunkte unten direkt zu testen.

    ⚠️ Sicherheit des API-Schlüssels

    • • Bewahre deinen API-Schlüssel sicher auf und teile ihn nie
    • • Generiere einen neuen Schlüssel, wenn er kompromittiert wurde

    API-Endpunkte

    Teste alle Endpunkte direkt aus dieser Dokumentation. Gib deinen API-Schlüssel ein und probiere die verschiedenen Funktionen aus.

    Allgemein

    GET
    /api/v1/status
    Authentifizierung erforderlich

    API-Status prüfen

    Prüfe, ob die API online ist

    Konto

    GET
    /api/v1/analytics
    Authentifizierung erforderlich

    Analysen abrufen

    Abrufen der Analysen für den authentifizierten Webshop

    Dokumente

    GET
    /api/v1/documents
    Authentifizierung erforderlich

    Dokumente auflisten

    Liste aktuelle Dokumente auf

    POST
    /api/v1/documents/submit/sendpol
    Authentifizierung erforderlich
    Agency
    Enterprise

    Neues Dokument

    Senden Sie ein neues Dokument (Bestellung/Rechnung) per JSON an das Peppol-Netzwerk. Verfügbar im Agency- oder Enterprise-Tarif.

    Agency- oder Enterprise-Tarif erforderlich

    Diese POST-API zum Senden von Dokumenten ist nur im Agency- oder Enterprise-Tarif verfügbar. Aktualisieren Sie Ihr Abonnement, um diese Funktion zu nutzen.

    Agency- oder Enterprise-Tarif erforderlich - Sehen Sie sich die Codebeispiele und Antworten an, um zu verstehen, wie diese API funktioniert.

    POST
    /api/v1/documents/upload/{document_id}
    Authentifizierung erforderlich

    Dokument hochladen

    Lädt das Dokument effektiv zu Peppol hoch (übermittelt es im Netzwerk). Das Dokument muss sich in einem gültigen Status befinden, bevor es hochgeladen werden kann. Hinweis! Wenn die Kontoeinstellung auf automatisch steht, müssen Sie diese API nicht verwenden, um Ihre Dokumente zu Peppol hochzuladen, da dies automatisch geschieht.

    Hilfe nötig?

    Du hast Fragen zur API oder benötigst Unterstützung bei der Integration? Unser Entwicklungsteam hilft dir gerne weiter.