Startseite

Partner-API v1

Für Ihre eigene Datenbank

API-Dokumentation

Übernehmen Sie Ihre Aufträge direkt in Ihr ERP oder WaWi-System. Der Endpoint liefert die gleichen Daten wie die Übersicht im Portal — wahlweise als JSON, XML oder Markdown.

Authentifizierung

Alle Anfragen benötigen den Header x-api-key mit Ihrem partner-spezifischen Schlüssel. Alternativ akzeptiert der Endpoint einen Authorization: Bearer … Header.

Ihren Produktions-Key erhalten Sie nach Freischaltung im Admin-Backend. Zum Testen können Sie den Demo-Key verwenden — er liefert einen statischen Beispiel-Auftrag zurück:

DEMO-ASP-2026-0001
Endpoint
GET
GET https://hilfsmittelpartner.myallergosmart.care/api/public/partner/orders

Query-Parameter

  • formatjson (Default), xml oder md
  • status — optionaler Filter: assigned, shipped, delivered, invoiced
Beispiele

cURL — JSON

curl -H "x-api-key: DEMO-ASP-2026-0001" \
  "https://hilfsmittelpartner.myallergosmart.care/api/public/partner/orders?format=json"

cURL — XML

curl -H "x-api-key: DEMO-ASP-2026-0001" \
  "https://hilfsmittelpartner.myallergosmart.care/api/public/partner/orders?format=xml" -o auftraege.xml

cURL — Markdown

curl -H "x-api-key: DEMO-ASP-2026-0001" \
  "https://hilfsmittelpartner.myallergosmart.care/api/public/partner/orders?format=md" -o auftraege.md

JavaScript (Fetch)

const res = await fetch("https://hilfsmittelpartner.myallergosmart.care/api/public/partner/orders?format=json", {
  headers: { "x-api-key": "DEMO-ASP-2026-0001" }
});
const { orders } = await res.json();
console.log(orders);

Python (requests)

import requests
r = requests.get(
    "https://hilfsmittelpartner.myallergosmart.care/api/public/partner/orders",
    headers={"x-api-key": "DEMO-ASP-2026-0001"},
    params={"format": "json"},
)
for order in r.json()["orders"]:
    print(order["case_id"], order["status"])
Antwort-Schema (JSON)
{
  "partner": { "id": "…", "name": "Demo Encasing GmbH" },
  "generated_at": "2026-07-22T10:15:00.000Z",
  "count": 1,
  "orders": [
    {
      "case_id": "ASP-CASE-2026-000123",
      "status": "assigned",              // assigned | shipped | delivered | invoiced | reassigned
      "assigned_at": "2026-07-22",
      "deadline_delivery": "2026-07-23", // Frist 1: assigned_at + 1 Tag + lead_time
      "deadline_data": "2026-07-29",     // Frist 2: assigned_at + 7 Tage
      "patient_ref": "PSN-8xk93",        // pseudonymisiert
      "commission_net_cents": 1049,      // Serviceentgelt netto in Cent
      "articles": [
        {
          "sku": "K-090x200",
          "kind": "matratze",            // kissen | decke | matratze | topper
          "size": "90x200",
          "tier_key": "standard",        // Ausführungsstufe
          "upgrade_cents": 0             // Aufpreis netto in Cent
        }
      ]
    }
  ]
}
Rate-Limits & Verhalten

60 Anfragen/Minute pro API-Key. Polling-Intervall: nicht häufiger als alle 60 Sekunden empfohlen.

Fehlercodes: 401 fehlender oder ungültiger Key · 429 Rate-Limit überschritten · 5xx temporäre Störung (Retry mit Backoff).

Die Schnittstelle ist versioniert über den Pfad; Breaking Changes erhalten eine neue Version (/api/public/partner/v2/orders).

Sie brauchen Ihren Produktions-Key?

Nach abgeschlossenem Onboarding und gegengezeichnetem Vertrag wird Ihr persönlicher API-Key im Admin-Backend ausgestellt. Bis dahin testen Sie mit dem Demo-Key oben.

Zurück zur Übersicht