← Alle Themen · API

Public API

Die Scanalot Public API ermöglicht die programmatische Anbindung externer Systeme an Ihre Scanalot-Instanz. Sie können Artikel, Aufträge, Lagerbestände und weitere Daten lesen und schreiben.

Authentifizierung

Die API verwendet eine zweistufige Authentifizierung:

1. URL-Token

Jede Scanalot-Instanz besitzt ein individuelles URL-Token, das Bestandteil der Basis-URL ist. Dieses Token wird automatisch aus den Instanzdaten generiert und ist für Ihren Account fest vergeben.

Basis-URL:

https://<ihre-domain>/public_api/<url-token>/

Beispiel:

https://meinefirma.scanalot.io/public_api/a1b2c3d4e5f6g7h/

Das URL-Token erhalten Sie vom Scanalot Support. Kontaktieren Sie uns, um Ihren API-Zugang einrichten zu lassen.

2. Authorization-Header

Zusätzlich zum URL-Token muss jeder Request einen Authorization-Header mit einem gültigen Benutzer-API-Token enthalten. Diesen Token finden Sie in den Benutzereinstellungen Ihrer Scanalot-Instanz.

Authorization: <ihr-api-token>

Beispiel-Request mit curl:

curl -X GET "https://meinefirma.scanalot.io/public_api/a1b2c3d4e5f6g7h/items?sku=ABC" \
  -H "Authorization: mein-api-token-12345"

Fehler bei fehlender Authentifizierung

Wenn der Authorization-Header fehlt oder ungültig ist, erhalten Sie:

{
  "valid": false,
  "error": "header 'Authorization' missing"
}

HTTP-Statuscode: 403 Forbidden

Rate Limiting

Das API-Limit richtet sich nach Ihrem gebuchten Tarif. Bei Überschreitung erhalten Sie:

{
  "valid": false,
  "error": "limit reached"
}

HTTP-Statuscode: 429 Too Many Requests

Antwort-Format

Alle API-Antworten sind im JSON-Format. Erfolgreiche Antworten enthalten immer "valid": true, Fehler enthalten "valid": false und ein error-Feld mit der Fehlerbeschreibung.

Erfolg:

{
  "valid": true,
  "data": [...]
}

Fehler:

{
  "valid": false,
  "error": "Beschreibung des Fehlers"
}

Endpunkte im Überblick

Artikel

Aufträge

Lager

Sonstige