desk4 Docs
NeukundenberatungImpressum
  • Home
  • Mein Benutzer
  • Dashboard
    • Aufgaben
  • Stammdaten
    • Artikel
    • Kunden
    • Lieferanten
    • Geräte
    • Hersteller
    • DHL-Pakete
    • Pakete
    • Projekte
    • Chargenverwaltung
  • Verkauf
    • Angebot
      • Angebote nachhaken
      • Aufmaß
    • Aufträge
    • Prime Auftrag
    • Lieferscheine
      • DHL Paket
      • Pakete
      • UPS-Versandexport
    • Rechnungen
      • E-Rechnung / XRechnung /ZUGFeRD
    • Rücknahmen
    • Gutschriften
    • Stornierungen
    • Abschlagsrechnungen
    • Abo-Rechnungen
    • Vorlagen
    • Arbeitsnachweise
    • Seriendruck, -mailversand / Stapelverarbeitung
    • Barverkauf
  • Einkauf
    • Bestellvorschläge
    • Lieferantenanfragen
    • Bestellungen
    • Wareneingang
    • Eingangsrechnungen
    • Rücksendungen (an den Lieferanten)
    • Eingangsgutschriften
    • Chargenverwaltung
  • Kassen
    • Kassen
    • Kassenbelege
    • Warenkörbe
  • Finanzen
    • Offene Posten-Verwaltung
      • Offenen Posten übernehmen
      • Offene-Posten Zahlung
    • Zahlungszuweisung
    • Zahlungen
      • Bankzahlungen
      • EC-Zahlungen
      • Barzahlungen
      • PayPal Zahlungen
      • Kassenbuch
      • Sonstige Zahlungsarten
    • DATEV
  • Auswertungen
    • Berichte
    • Umsatz
    • Kennzahlen
    • Chefauswertungen
    • Provisionsverwaltung
  • Werkzeuge
    • Importe
      • Artikelimport
        • Artikelexport aus Lexware für den Import in desk4 vorbereiten
      • Artikelbilderimport
      • Eigenschaftenimport
      • Artikelpreisimport
      • Bestandsimport
      • Herstellerimport
      • Kundenimport
        • Kundenexport aus Lexware in desk4 importieren
      • Ansprechpartnerimport
      • Lieferantenimport
      • Lieferantenpreisimport
      • Preislistenimport
      • Warengruppenimport
      • Warengruppenrabatteimport
    • Exporte
    • Inventur
      • Inventur auf Mobilgeräten
    • Lagerbewegungen
    • Drucklayouts
      • Drucklayout - Einstellungen
    • Textbausteine
    • Backup erstellen
    • Scripts
    • Cron-Aufgaben
      • Cron-Aufgaben Bestands und Artikel Export und Import
    • Chargendokumentation
    • Wartungsmodus / Wartungszugang
  • Fertigung
  • Shopanbindung
    • Shop anbinden
    • Installation Shopware 5/6 Plugin
    • Amazon Schnittstelle anbinden und konfigurieren
    • Gambioschnittstelle konfigurieren
    • Shopify Schnittstelle konfigurieren
    • Shopwareschnittstelle konfigurieren
    • WooCommerce Schnittstelle konfigurieren
    • Hilfen für Importe von desk4 zu Shopware
      • Artikelbilderimport - desk4 zu Shopware 6
    • Abruf der Produktinformationen bei Bestellungen und automatisches Anlegen von Artikeln (Shopware 6)
  • Dokumentenmanagement System (DMS)
  • Einstellungen
    • Grundeinstellungen
      • Präfixe
      • Startnummern
      • E-Mail (SMTP-Konto & DKIM)
        • Microsoft Exchange & 365 SMTP-Einrichtung mit einem App-Passwort
        • Gmail (Google Workspace) SMTP Einrichtung mit einem App Passwort
        • E-Mail auf Spam-Verdacht prüfen (falls E-Mails nicht beim Kunden ankommen)
      • SKR
      • Abo-Rechnungen
      • Offene Posten
      • DATEV
      • Texte
      • ChatGPT (OpenAI)
      • Benutzerdefinierte Felder
      • Variablen für Anrede, Vorname, Nachname und Briefanrede
    • Filialen
    • Versandanbieter
      • DHL-Anbindung
    • Shipcloud
    • Arbeitsnachweisart
    • Artikel
      • Artikeleigenschaften
      • Warengruppen
      • Gewichtseinheiten
      • Lager
      • Mengeneinheiten
      • Preislisten
    • Finanzen
      • Länder
      • Zahlungsbedingungen
      • Zahlungsarten
      • Versandart
      • Steuerkonten
      • Kostenstellen
      • Steuersätze
      • Währungen
      • Abo-Rechnungen Titel
    • Kunden
      • Kundeneigenschaften
      • Kundengruppen
      • CRM-Eintragsart
      • Passworttypen
      • Bankdaten
      • Löschfristen - Dateiarten
    • Mitarbeiter
      • Mitarbeiter
        • Zugangsdaten und Passwort anpassen
      • Gruppen
      • Passwortgruppen
      • Fehlerhafte Logins
      • Gesperrte Logins
    • DMS
      • Arten
      • DMS-Gruppen
  • FAQ
    • QR Code (Swiss QR Bill) auf Rechnungen
    • desk4 Verfahrensdokumentation nach GoBD
      • Hilfestellung Verfahrensdokumentation nach GoBD
    • 13b und Reverse Charge
    • Adressdaten der Kunden anpassen
    • Apps (iOS, Android, Windows u. MacOS)
    • API-Zugang
    • Artikelnummern Vorgabe
    • Barcode / EAN-Scanner
    • Barverkauf
    • Beleg duplizieren / kopieren
    • Beleg wird nicht gedruckt (Browsereinstellungen: Pop-up-Fenster erlauben)
    • E-Mail-Adressen: Empfänger-Vorauswahl beim Belegversand
    • Erstellt und Bearbeitet
    • Artikeletiketten drucken
    • Gutscheine und Rabattaktionen vom Online-Shop
    • Filtern, sortieren und weitere Werte auf der Übersichtsseite ein- und ausblenden
    • Hilfe & Support
    • Kommissionierung (Packliste)
    • Kunden
    • Lagerplatz
    • Login
    • Logout
    • Module buchen
    • DHL-Pakete
    • Pakete
    • Passwörter
    • Passwort vergessen
    • Positionstabellenmenü
    • Revisionssichere PDFs /ZUGFeRD
    • Roadmap
    • Roter Pfeil / Direktverknüpfung zu Kunden, Lieferanten, Artikeln und Belegen
    • Sammeltransfer (über "Weiterführen zu")
    • Schulung
    • Seriendruck, -mailversand / Stapelverarbeitung
    • Seriennummern
    • Sprache auswählen
    • Standardkontenrahmen
    • Status
    • Status "Verbucht" in einem Beleg
    • Tastaturkürzel
    • TeamViewer Freigabe am Mac
    • Übernahme
    • Versandkosten
    • Voraussetzungen für desk4
    • Was sind die Beschränkungen für den Massenversand?
    • Wizard
    • Workshops buchen
    • Wunschkiste
    • Zwei-Faktor-Authentifizierung
  • Changelog
  • Roadmap
  • Wunschkiste
  • Zurück zu desk4
Powered by GitBook
On this page
  • Login und Anmeldung
  • Beispiel Daten (JSON)
  1. FAQ

API-Zugang

PreviousApps (iOS, Android, Windows u. MacOS)NextArtikelnummern Vorgabe

Last updated 6 days ago

Login und Anmeldung

Um Zugriff auf die API zu erhalten, wird der Benutzer als API-Benutzer (Checkbox im Kopfmenü anhaken) gekennzeichnet.

Über diesen Haken öffnet sich die REST-Schnittstelle. Hier kann man nun anhaken, welche Rechte der API Benutzer haben soll.

Für den API Benutzer sollte keine Berechtigungs-Gruppe eingestellt sein.

Mehr über Mitarbeiter-Einstellungen erfahren Sie

Die komplette Dokumentation der API Schnittstelle für desk4, finden Sie unter folgenden Link:

Mit dem API-Benutzer können Sie anschließend ein WebToken zur Authentifizierung erzeugen. Ein erzeugter Webtoken ist 30 Minuten gültig.

In den Body müssen dafür die Benutzerdaten nach folgendem Schema eingefügt werden:

{
"userName": "admin",
"password": "admin",
"branchID": 1,
"killExistingSession": true
}

Beachten Sie, dass die korrekte Methode ausgewählt sein muss (in diesem Fall „Post“).

API Pfad: https://demo.desk4.net/rest/v1/session/webtoken

Das erhaltene WebToken fügen Sie nun im Header in der Form „Bearer +WebToken“ als Value und „Autorization“ als Key ein, um so auf die API zugreifen zu können.

Alternativ können Sie auch die URL Ihrer desk4 Instanz für „demo.desk4.net“ einsetzen.

Beispiel Daten (JSON)

Um auf die Dokumentation der API zuzugreifen, rufen Sie folgenden Link auf:

https://demo.desk4.net/q/swagger/
hier.
https://demo.desk4.net/q/swagger/
737B
createCustomer.json
Benutzer anlegen
2KB
createDocument.json
Belege erstellen
477B
createProduct.json
Artikel anlegen