Um die ersten Funktionen der DMS API aufzurufen, müssen die folgenden Schritte ausgeführt werden:

 1) Ermitteln der Basis-URL (d3oneBaseUri) und des API-Key (apiKey) für das gewünschte d.3one Zielsystem.

Für die Verwendung der unten stehenden Quellcode-Beispiele kann als d3oneBaseUri die URI unseres offenen Testsystems https://tp-dev.d-velop.cloud/ verwendet werden. Bitte beachten, dass alle dort erzeugten Daten für alle Nutzer des Testsystems sichtbar sind. Für einen Benutzerzugang bitte per E-Mail an cloud.support@d-velop.de wenden.

Optional kann ein persönliches Testsystems hier gebucht werden: https://order.d-velop.cloud/register

Um einen apiKey auf dem gewünschten Zielsystem anzulegen, muss in der Anwendungsoberfläche von d.3one im Home Screen auf die Kachel "Identity Provider" geklickt und anschließend rechts das "Fingerabdruck"-Symbol ausgewählt werden. Die Kachel "Identity Provider" ist für d.3one Administratoren sichtbar.

 2) Festlegen einer Quelldefinition für das Mapping

Für die Nutzung von API-Funktionen ist die Definition eines Mappings) erforderlich. Hierbei werden Informationen über Dokumentarten und deren Eigenschaften einer Quelle (beispielsweise eines ERP oder einer anderen Fachanwendung) mit denen eines Ziels (DMS-Funktionen in d.3one) verbunden.

Die Definition einer Quelle wird in JSON erstellt, einmal für die Quelldefinition selbst (source.json), sowie für die Route zur Quelldefinition (sourceurl.json).

Beispiel für eine source.json und für eine sourceurl.json

 3) Erstellen einer Web-Applikation zur Auslieferung der Quelldefinition

Die JSON-Informationen müssen von einer Webapplikation per HTTP oder HTTPS ausgeliefert werden. Diese Webapplikation (yourWebAppName) muss für das d.3one Zielsystem erreichbar sein.

Hinweis

  • Um Konflikte mit anderen Quelldefinitionen zu vermeiden, sollte in yourWebAppName als Prefix ein Unternehmensname verwendet werden. Beispielsweise myCompanyMyMapping.
  • Bindestriche oder Minuszeichen dürfen in yourWebAppName nicht verwendet werden!
  • Der Name der Webapplikation muss der erste Teil der URI nach der Basis-URL sein. Beispielsweise https://yourWebHostUri/yourWebAppName

Beispielhaft ist hier eine einfache Möglichkeit zur Bereitstellung einer Webapplikation erläutert. Grundsätzlich kann eine Webapplikation aber auch aber auch inidividuell und mit der Technik eigener Wahl erstellt werden.

Einrichten einer statischen Website mit einer benutzerdefinierten Domäne

Verzeichnisse im Bucket anlegen:

   ...\yourWebAppName
...\yourWebAppName\sources

JSON-Informationen als json-Dateien erstellen:

   ...\yourWebAppName\sourceurl.json and
...\yourWebAppName\sources\source.json

Umbenennen der Dateien in index.json

   ...\yourWebAppName\index.json and
...\yourWebAppName\sources\index.json

  • In den Eingeschaften für "Static website hosting" muss "Index document" auf index.json gesetzt werden.
  • Die Berechtigung "list objects" für den öffentlichen Zugriff auf den Bucket setzen.
  • Den Content-Type application/json für beide json-Dateien setzen (In AWS-console: Datei im Bucket auswählen und Tab "Èigenschaften" und dann Kachel "Metadaten" auswählen).

 4) Neue App im d.3one Zielsystem registrieren.

Die Registrierung der Webapplikation macht die Quelldefinition für d.3one bekannt. Sofern das Testsystems https://tp-dev.d-velop.cloud/ verwendet wird, bitte eine E-Mail mit folgenden Informationen an cloud.support@d-velop.de senden:

  • Betreff: Registrierung einer Webapplikation für Quelldefinitionen
  • Die URI der Webapplikation zur Bereitstellung der Quelldefinition: http://yourWebHost/yourWebAppName

Sofern ein anderes d.3one Zielsystem verwendet wird, kann die Registrierung einer App über d.ecs http gatway admin erfolgen.

 5) Konfiguration des Mappings

Die Verbindung von Quelldefinition mit dem d.3one Zielsystem erfolgt über die Kachel "Zuordnungen". Diese Kachel ist für d.3one Administratoren sichtbar.

 6) Start coding ;-)

bitte beachte unsere Sicherheitsrichtlinie