SecureSafe Exchange Erstellung über API
Übersicht
Es gibt zwei Möglichkeiten, eine SecureSafe Exchange zu erstellen:
-
Über das Admin Portal kann ein Client Advisor eine SecureSafe Exchange für einen Kunden erstellen.
-
Über API-Endpunkte kann ein Anbieter SecureSafe Exchanges für seine Kunden erstellen und verwalten. Dies wird im folgenden Abschnitt detailliert beschrieben.
Erfahren Sie mehr:
Für detaillierte Integrationshinweise siehe API-Dokumentation und Beispielcodes.
Erstellung der SecureSafe Exchange
Um eine SecureSafe Exchange über API zu erstellen, muss ein Anbieter folgende Angaben bereitstellen:
|
Eigenschaft |
Kardinalität |
Beschreibung |
|---|---|---|
|
Username |
verpflichtend |
Benutzername des Kundenkontos. Muss eindeutig sein; Verwendung einer UUID wird empfohlen. |
|
External user id |
verpflichtend |
Externe ID des Kundenkontos. Muss eindeutig sein; Verwendung einer UUID wird empfohlen. |
|
Client language code |
verpflichtend |
Sprachcode der Standardsprache des Kunden. Mögliche Werte: "DE", "EN", "FR", "IT". |
|
Password |
verpflichtend |
Passwort des Kundenkontos. Muss vom Anbieter gespeichert werden. |
|
Client first name |
optional |
Vorname des Kunden. maxLength: 64, minLength: 1. |
|
Client last name |
optional |
Nachname des Kunden. maxLength: 64, minLength: 1. |
|
Client email address |
verpflichtend |
E-Mail-Adresse des Kunden. Muss syntaktisch gültig sein. |
|
Client mobile number |
verpflichtend |
Mobilnummer des Kunden. Wird für den zweiten Faktor (2FA) verwendet. |
|
External SecureExchange id |
verpflichtend |
Externe ID der SecureSafe Exchange. Muss pro Anbieter eindeutig sein; Verwendung einer UUID wird empfohlen. |
|
SecureExchange name |
verpflichtend |
Name der SecureSafe Exchange (entspricht dem Namen des erstellten Team Safes). |
|
SecureExchange description |
optional |
Kurzbeschreibung des Zwecks der SecureSafe Exchange. Wird in der UI angezeigt. maxLength: 1024, minLength: 1. |
|
Client advisor first name |
optional |
Vorname des Client Advisors. maxLength: 64, minLength: 1. Wird dem Endnutzer als Kontaktinformation angezeigt. |
|
Client advisor last name |
optional |
Nachname des Client Advisors. maxLength: 64, minLength: 1. Wird dem Endnutzer als Kontaktinformation angezeigt. |
|
Client advisor mobile number |
optional |
Mobilnummer des Client Advisors. Diese Information ist für den Endnutzer als Kontaktinformation sichtbar, sodass er den Anbieter bei Fragen oder Anliegen kontaktieren kann. Es kann jede Mobilnummer verwendet werden, unter der der Anbieter vom Endnutzer erreichbar sein soll. |
|
Client advisor email address |
optional |
E-Mail-Adresse des Client Advisors. Muss eine syntaktisch gültige E-Mail-Adresse sein. Diese Information ist für den Endnutzer als Kontaktinformation sichtbar, sodass er den Anbieter bei Fragen oder Anliegen kontaktieren kann. Es kann jede E-Mail-Adresse verwendet werden, unter der der Anbieter vom Endnutzer erreichbar sein soll. |
Aktualisierung der SecureSafe Exchange
Die folgenden SecureSafe Exchange Angaben können über die Endpunkte „update team safe“ oder „update account“ aktualisiert werden:
-
SecureExchange name
-
SecureExchange description
-
Client language code
-
Client advisor first name
-
Client advisor last name
-
Client advisor email address
-
Client advisor mobile number
Es gelten dieselben Einschränkungen wie bei der Erstellung.
Löschen der SecureSafe Exchange
Über API erstellte SecureSafe Exchanges können über den „delete“ Endpoint gelöscht werden.
Datei in SecureSafe Exchange hochladen
Über den „Upload“ Endpoint kann ein Anbieter eine Datei in einen bestimmten Ordner hochladen.
Ordner in SecureSafe Exchange umbenennen
Erstellte Ordner können über den „rename team safe folder“ Endpoint umbenannt werden.
SecureSafe Exchange Ereignisse
Damit der Anbieter über Änderungen in einer SecureSafe Exchange informiert wird, werden folgende Events erstellt und per Webhooks übermittelt:
-
Document upload event
-
Document shared event
-
Document deleted event
Es liegt in der Verantwortung des Anbieters, auf diese Events entsprechend zu reagieren. Beispielsweise kann der Client Advisor benachrichtigt werden, wenn ein Kunde ein Dokument hochlädt oder teilt.