Virtual Marketer ERP
Inhalt der Dokumentation

Demo und Erster Blick

Demo-Zugang und Startzustand.

5 Funktionen. Aufruf unter /api/method/<Pfad>, Anmeldung und Fehlerformat stehen unter Authentifizierung und Fehlermodell.

vm_erp.vm_erp.golive.api.demo_anmelden

  • POST
  • Öffentlich (ohne Anmeldung)
  • Fehlernummer bei unerwarteten Fehlern

Meldet den festen Demo-Leser an. Kein Parameter; der Benutzer kommt nie aus der Anfrage.

Nur mit beiden Flags (vm_demo_modus und vm_demo_login_offen), nur als POST von der eigenen Seite, mit Rollenpruefung des Kontos und Ratenbegrenzung je Client und global. Ohne Freigabe antwortet die Funktion generisch 'Nicht verfügbar'.

Rollen: Keine Anmeldung nötig.

Parameter: keine.

Felder der Antwort (message): ok, ziel

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.golive.api.demo_anmelden"
{"message": ...}

vm_erp.vm_erp.golive.api.demo_einladung_anmelden

  • POST
  • Öffentlich (ohne Anmeldung)
  • Fehlernummer bei unerwarteten Fehlern

Meldet mit einem gueltigen Einladungslink den festen Demo-Leser an (POST von der eigenen Seite).

Gleiche Schutzschichten wie demo_anmelden: Herkunftspruefung, exakte Rollenpruefung des Kontos, Ratenbegrenzung, 60-Minuten-Sitzung (fail closed). Das Flag vm_demo_login_offen ist nicht noetig, der signierte Link ist die Berechtigung.

Rollen: Keine Anmeldung nötig.

ParameterTypPflichtBeschreibung
tstringnein
curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.golive.api.demo_einladung_anmelden"
{"message": ...}

vm_erp.vm_erp.golive.api.demo_einladung_seite

  • GET
  • Öffentlich (ohne Anmeldung)
  • Fehlernummer bei unerwarteten Fehlern

Landeseite des Einladungslinks (GET). Meldet NIE an: Mailscanner und Linkvorschauen koennen nichts ausloesen.

Zeigt bei gueltigem Token einen Knopf 'Demo oeffnen', der per POST anmeldet. Ohne Demo-Modus und Geheimnis (auch auf Produktion) antwortet sie generisch 'Nicht verfuegbar'. Das Token steht nirgends im Protokoll.

Rollen: Keine Anmeldung nötig.

ParameterTypPflichtBeschreibung
tstringnein
curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.golive.api.demo_einladung_seite"
{"message": ...}

vm_erp.vm_erp.golive.api.demo_status

  • GET
  • Öffentlich (ohne Anmeldung)
  • Fehlernummer bei unerwarteten Fehlern

Gast, nur lesend: darf die Anmeldeseite den Knopf 'Als Demo ansehen' zeigen? Verraet sonst nichts.

Rollen: Keine Anmeldung nötig.

Parameter: keine.

Felder der Antwort (message): verfuegbar

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.golive.api.demo_status"
{"message": ...}

vm_erp.vm_erp.golive.api.erster_blick

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Daten fuer die Seite 'Erster Blick': ein Auftrag mit seinen vier Ampeln.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.golive.api.erster_blick"
{"message": ...}