Die cludes REST API bietet einen Zugriff auf die Daten von cludes. Es lassen sich Daten auslesen, modifizieren, löschen und hinzufügen.
Die API wird in cludes als Schnittstelle angelegt. Es können mehrere API Gateways für unterschiedliche Zwecke benutzt werden (i.d.R. reicht aber eine).
Die Konfiguration wird normalerweise durch den cludes Support vorgenommen.
Für die Autorisierung gegen die cludes API kann in der Schnittstelle ein API Schlüssel erstellt werden.
Für den Zugriff auf die API können für die unterschiedlichen Zugriffsmethoden (GET, POST, PUT, DELETE) die jeweiligen Ressourcen freigeschaltet werden, sofern sie über entsprechende Zugriffspunkte verfügen.
Für die Abfrage von Artikeln werden standardmäßig die Zuordnungen der Artikel zur API Schnittstelle verwendet, man kann aber auch jede beliebige andere Schnittstellennummer für die Ausgabe der Daten angegeben (kommagetrennte Mehrfachangabe möglich). Möchte man alle Produkte ausgeben, gibt man in dem Feld den Text "all" ein.
Ferner hat man die Möglichkeit die Zugriffe auf die Ressource zu beschränken. Dies aktiviert zusätzliche Sicherheitsmechanismen die erst durchgeführt werden müssen bevor Kunden oder Bestelldaten abgerufen werden können (siehe dazu genauer in der Entwicklerdokumentation).
Zu der Schnittstelle kann auch eine weitere Extension angelegt werden die ebenfalls als Schnittstelle hinterlegt wird. Diese erweitert die Funktionalität der cludes api auf bestimmte Funktionen die hauptsächlich für Shopsysteme interessant sind. Gegenwärtig werden diese Ressourcen hauptsächlich von dem cludes eigenen, auf Wordpress basierenden Shop verwendet.
Dort lassen sich Einstellungen wie Zahlungsarten, die URL für den Shop und die Art der Ausgabe des Artikelnamens definieren.
Entwickler Dokumentation als PDF Herunterladen:
/resources/CludesAPIEntwicklerDoku.pdf