Set up API access
1. Bestätigen Sie, dass der Shop für das Pilotprogramm freigegeben ist
Alva muss den Shop freigeben, bevor API-Schlüssel erstellt oder verwendet werden können. Wenn der Zugriff noch nicht aktiv ist, kontaktieren Sie admin@alvaapps.com.
2. Einen API-Schlüssel erstellen
Öffnen Sie die Alva-Einstellungen, wählen Sie API-Schlüssel und erstellen Sie einen Schlüssel für die Integration. Kopieren Sie das Token einmalig und speichern Sie es in einem Secret-Manager. Alva speichert nur eine öffentliche Schlüssel-ID und einen Hash des Secrets.
3. Das Token als Bearer-Header senden
Senden Sie jede Anfrage mit Authorization: Bearer adk_live_.... Ein fehlender, fehlerhafter, unbekannter oder widerrufener Schlüssel gibt dieselbe Unauthorized-Antwort zurück, sodass Angreifer keine gültigen Schlüssel ermitteln können.
4. Idempotenz-Schlüssel bei Schreibvorgängen einbeziehen
Jede Nicht-GET-Anfrage muss einen Idempotency-Key-Header enthalten. Bei Wiederverwendung desselben Schlüssels und Bodys wird eine erfolgreiche Antwort sicher erneut zurückgegeben, statt ein doppeltes Asset, eine doppelte Zuordnung, Zuweisung oder Zugriffsänderung zu erstellen.
Assets erstellen und Produkte zuordnen
Verwenden Sie POST /api/v1/assets, um eine Remote-Datei von einem freigegebenen Host zu importieren, oder nutzen Sie die Direkt-Upload-Endpunkte, wenn Ihre Integration selbst in den Alva-Speicher hochlädt. Fragen Sie GET /api/v1/jobs/{job_id} ab, bis der Remote-Import abgeschlossen ist.
Sobald das Asset existiert, erstellen oder aktualisieren Sie eine Zuordnung mit POST /api/v1/mappings. Produkt-IDs sollten das Shopify-GID-Format verwenden. Die API begrenzt jede Zuordnung auf den dem API-Schlüssel zugeordneten Shop.
Downloads Bestellungen zuweisen
Verwenden Sie POST /api/v1/orders/{shopify_order_id}/assignments, wenn ein externes System einem Kunden Zugriff auf zugeordnete digitale Produkte gewähren muss. Die Zuweisung kann den Kundendatensatz anlegen, den Kauf erstellen und optional die Liefer-E-Mail versenden.
Verwenden Sie die Bestellzugriffs-Endpunkte, um den Zugriff zu widerrufen, wiederherzustellen, zusätzliche Downloads zu gewähren oder die Liefer-E-Mail erneut zu senden. Diese Aktionen sind auf den Shop begrenzt und akzeptieren keine Shop-IDs im Anfrage-Body.
Die API-Dokumentation lesen
Nutzen Sie beim Erstellen einer Integration den Schnellstart, die Endpunkt-Referenz, den Fehlerleitfaden und die herunterladbare OpenAPI-Spezifikation.
FAQ
Kann jeder Händler die externe API verwenden?
Nein. Der API-Zugriff ist nach Freigabe verfügbar. Kontaktieren Sie admin@alvaapps.com, um den API-Zugriff für Ihren Shop zu aktivieren.
Do write requests need idempotency keys?
Ja. Jede Nicht-GET-Anfrage muss einen Idempotency-Key-Header enthalten, damit Wiederholungsversuche keine doppelten Assets, Zuordnungen, Zuweisungen oder Zugriffsänderungen erstellen.
See also
War das hilfreich?
Last updated 2026-06-05