Anwendungsgebiete
Für die ITscope API gibt es denkbar viele Anwendungsgebiete. Alle haben gemeinsam, dass Sie von den Vorteilen von ITscope profitieren können um die eigenen Produkte und Dienste zu bereichern. Zum Beispiel kann die Verwaltung von individuellen Preisen und Preislisten vollständig über ITscope erfolgen. Die bereits aufbereiteten Produkte mit den individuellen Preisen sind dann einfach über die API abzurufen. Ein doppeltes Nachprogrammieren der Einlesefunktionen ist somit nicht mehr nötig.
Warenwirtschaften
Die ITscope API bietet alle Abfragen um automatisiert mit einer Warenwirtschaft zu kommunizieren. Viele Funktionen der Webplattform ITscope.com können analog mit der API benutzt werden. Dazu zählen die Suche von Produkten sowie ein einzelner Produktabruf. Dabei führt die Warenwirtschaft zum Beispiel eine Suche nach EAN oder Schlüsselwörtern über die ITscope API durch und erhält die Antwort im gewünschten Format, zum Beispiel XML. Auch einzelne Produkte können auf diese Weise bequem abgerufen werden. Die Antwort kann dann Stammdaten, Verfügbarkeits- und Preisinformationen in Echtzeit und erweiterten Content sowie Deeplinks in die ITscope Plattform enthalten. Sollen sehr viele Produkte mit den Stammdaten der Warenwirtschaft abgeglichen werden kann dafür der API-Aufruf für Exporte genutzt werden, die vorher in der ITscope Plattform eingerichtet wurden.
Weitere Details sind in dem Artikel Möglichkeiten der Integration in eine Warenwirtschaft zu finden.
Webseiten und Shops
Webseiten und Shops profitieren vom mächtigen, aufbereiteten Produktkatalog von ITscope, welcher sehr einfach über die API zugänglich ist. Alle bekannten Suchmechanismen von der ITscope Plattform können verwendet werden – insbesondere auch die Filter. Die Produkte kommen dann im gewünschten Format zurück und können direkt weiter weiterverarbeitet werden.
Auch das automatische Befüllen des Produktstamms eines Shops ist über die API möglich. Dazu kann zum Beispiel der in der Plattform vorbereitete Export zum gewünschten Zeitpunkt abgerufen werden.
Anwendungsmatrix
| Anwendungsfall | Request Methode | Anzahl API-Calls | Info | Tipp |
|---|---|---|---|---|
| Produkte | ||||
| Abruf/Anlage eines Artikels | GET/products/id/{itscopeid}/standard.json | 1 | Ein Abruf je Artikel | Abruf im Batch bis zu 50 Artikel = 1 Request |
| Laden einer resultierenden Produktliste aus einer Produktsuche nach Keywords | GET/products/search/{filter}/standard.json | 1 | Ein Abruf kann bis zu 50 Produkte beinhalten (jede weitere Seite 1 Call mit 50 Produkten) | Enthält alle (bis zu 50) Artikeldaten, sodass ich dann alle Artikel anlegen kann. |
| Aktualisierung ein im ERP System bereits bestehender Artikel | GET/products/id/{itscopeid}/standardUpdate.json | 1 | Ein Abruf je Aktualisierung | Aktualisierung im Batch bis zu 50 Artikel = 1 Request |
| Warenkröbe Verwalten | ||||
| Erstellen eines Warenkorbs | POST/business/carts | 1 | Einen neuen Warenkorb anlegen und im ITscope Frontend bearbeiten | |
| Bearbeiten eines Warenkorbs (umbenennen) | PUT/business/carts/{cartId} | 1 | ||
| Löschen eines Warenkorbs | DELETE /business/carts/{cartId}/cartlineitems/{lineItemId} | 1 | ||
| Hinzufügen von 1 Produkt in bestehenden Warenkorb | POST/business/carts/{cartId}/cartlineitems | 1 | ||
| Zusätzliche Optimierung des Warenkorbs beim Hinzufügen von Produkten | POST/business/carts/{cartId}/optimiseStrategy=minprice | 1 | Warenkorb beim Hinzufügen eines Artikels optimieren nach, günstigster, wenigsten Lieferanten etc. | |
| Optimierung Produkte in einem bestehendem Warenkorb | PUT /business/carts/{cartId}/optimise | 1 | Warenkorb optimieren nach, günstigster, wenigsten Lieferanten etc. | |
| Löschen Produkte aus einem Warenkorb | DELETE/business/carts/{cartId}/cartlineitems/{lineItemId} | 1 | ||
| Abruf eines Warenkorbs | GET/business/carts/{cartId}/cart.json | 1 | Einen bestimmten Warenkrob aufrufen | |
| Auflistung aller Warenkörbe | GET/business/carts/cart.json | 1 | Alle Warenkörbe auflisten | |
| Bestellungen | ||||
| Übertragen einer Bedarfsliste aus dem ERP in einen bereits in ITscope bestehenden Warenkorb | POST/business/carts/{cartId}/cartlineitems | 1 | Unabhängig von Anzahl Artikel (mit einem Call können beliebig viele Produkte in einen Warenkorb gelegt werden) | |
| Übernahme ITscope Warenkorb in ein ERP | GET/business/carts/{cartId}/cart.json | 1 | ||
| Abruf Bestelldokumente | GET/business/documents/{transactionId}/ORDERRESPONSE.xmlGET /business/documents/{transactionId}/DISPATCHNOTIFICATION.xmlGET /business/documents/{transactionId}/INVOICE.xml | 1 | Ein Abruf je Dokument | Nutzung von Webhooks |
| Abruf Bestelldokumente mit Artikel, die noch nicht im ERP vorhanden sind | GET/products/id/{itscopeid}/standard.json | 1 | Ein Abruf je fehlender Artikel | Abruf der Artikel im Batch (bis 50 Artikel) |
| Übernahme eine in ITscope abgesendete Bestellung in ein ERP | GET/business/documents/{transactionId}/ORDERRESPONSE.xmlGET /business/documents/{transactionId}/DISPATCHNOTIFICATION.xmlGET /business/documents/{transactionId}/INVOICE.xml | 1 | Wie in Abruf Bestelldokumente; es können auch rein Bestellungen abgerufen werden | |
| Übernahme eines in ITscope erstelltem Angebot in ein ERP | GET/business/quotes/{quoteId}/quote.xmlGET /business/documents/{transactionId}/QUOTATION.xml | 2 | Angebot-Metadaten + (openTRANS) Quotation.xml + zusätzliche Abrufe für Artikelanlage | |
| Auslösen einer Bestellung aus einem ERP | POST/business/deals/send | 1 bis 2 | 1 Abruf bei Versand der Bestellung; 2 Abrufe bei vorheriger Validierung des Bestelldokuments | |
| Übernahme eines Auftrags aus ITscope in ein ERP | GET/business/deals/{dealId}/deal.json | 1 | Wie in Abruf Bestelldokumente; es können auch rein Aufträge abgerufen werden | |
| Übernahme eine in ITscope erzeugte Sammlung in ein ERP | GET/products/ids/{itscopeids}/standard.json | 1 bis x | Abhängig von der Anzahl Artikel (siehe Abruf/Anlage eines Artikels) | Sammlung hat das Prinzip eines Triggers an die Fremdanwendung, Produkte über ganz normale Artikelanlage zu laden. |
| Meta Daten | ||||
| Lieferrantendaten bzgl. Anlegen von Distributoren in einem ERP | GET/company/distributor/eservices.json | 1 | Lieferanten-Metadaten – keine Begrenzung | |
| Herstellerdaten bzgl. Anlegen von Herstellern in einem ERP | GET/company/manufacturer/company.json | 1 | Hersteller-Metadaten – keine Begrenzung | |
| Abruf von Kategoriebäume für die Anlage in einem ERP | GET /products/producttypes/producttype.json | 1 | Kategorie-Metadaten – keine Begrenzung | |
| Lieferant | ||||
| Als Lieferant Abruf eingehender Bestellungen | GET/business/deals/purchase/deal.xml | 1 | Wie in Abruf Bestelldokumente; es können auch rein Aufträge abgerufen werden | |
| Als B2B-Shop Betreiber Änderung Status eingehender Aufträge | PUT/business/deals/advise/{dealId} | 1 | Je Status 1 Abruf | |
| B2B Shop | ||||
| Als B2B-Shop Betreiber Abruf eingehender Aufträge | GET | 1 | Wie in Abruf Bestelldokumente; es können auch rein Aufträge abgerufen werden | |
| Als B2B-Shop Betreiber ändere ich den Status eingehender Aufrträge | PUT/business/deals/advise/{dealId} | 1 | Je Status 1 Abruf | |
| Content | ||||
| Abruf Datenblatt (Datasheet) | GET/products/datasheet/id/{itscopeid}/datasheet.pdf | 1 | Je Datenblatt (Bilder sind kein API Call) – nur wenn Abruf über die API und nicht über den Export läuft |