Cloud-API-Geschäftsabläufe- und Konfigurationshandbuch
Verwendung der Cloud-API
REST-API-Grundlagen in Cloud-API
Die InsuranceSuite Cloud-API
Ressourcen
Endpunkte
Stammressourcen
Untergeordnete Ressourcen
Operationen
Pfade
Anforderungen und Antworten
Testen von Anforderungen und Antworten
Lernprogramm: Einrichten Ihrer Postman-Umgebung
Übersicht über die System-APIs in Cloud-APIs
Die System-APIs der Basiskonfiguration
Cloud-API-Versionen
Anzeigen von API-Definitionen
Swagger-Benutzeroberfläche
Anzeigen eine rAPI-Definition mit der Swagger-Benutzeroberfläche
Organisation von API-Informationen in der Swagger-Benutzeroberfläche
Die API-Definitionsendpunkte und Postman
Anzeigen einer API-Definition mit Postman
Organisation von Informationen in der Ausgabe von API-Definitionsendpunkten
Beta-APIs
Veröffentlichte APIs und Endpunkte
Beta-APIs und Beta-Endpunkte
Beta-APIs für diese Version
Zusätzliche Metadaten-Endpunktfunktionen
Funktionen für alternative API-Tools
Die /typelists-Endpunkte
Lernprogramm: Abfrage nach Typenlisten-Metadaten
Routing von zugehörigen API-Aufrufen in Cluster-Umgebungen
GETs und Antwort-Nutzdatenstrukturen
Übersicht über GETs
Standardisierung von Nutzdatenstrukturen
Anzeigen von Antwortschemas
Antwortschema in der Swagger-Benutzeroberfläche anzeigen
Senden von GETs
GET mit Postman senden
Lernprogramm: Eine einfache Postman-Anforderung senden
Nutzdatenstruktur für eine grundlegende Antwort
Struktur einer Grundantwort
Eigenschaft "count"
Abschnitt "data"
Abschnitt "attributes"
Feld "checksum"
Unterabschnitt "links" (für ein Element)
Abschnitt "links" auf Sammlungsebene
Nutzdatenstruktur für eine Antwort mit eingeschlossenen Ressourcen
Lernprogramm: Eine Postman-Anfrage mit eingeschlossenen Ressourcen senden
Struktur einer Antwort mit eingeschlossenen Ressourcen
Abschnitt "related" (für eine Ressource)
Abschnitt "included" (für eine Antwort)
Einschließen einer Sammlung oder einer bestimmten Ressource
Ermitteln, welche Ressourcen einbezogen werden können
Verfeinern von Antwort-Nutzdaten
Übersicht über Abfrageparameter
Anzeigen der Dokumentation von Abfrageparametern in der Swagger-Benutzeroberfläche
Fehlermeldungen zu Abfrageparametern
Festlegen der zurückzugebenden Ressourcen und Felder
Filtern von GETs
Lernprogramm: GET mit den Parametern filter senden
Festlegen, welche Felder über GET abgerufen werden sollen
Lernprogramm: GET mit dem Parameter fields senden
Abrufen von Ressourcen für ein bestimmtes Datum
Sortieren des Ergebnissatzes
Lernprogramm: GET mit dem Parameter für die Sortierabfrage senden
Steuerung der Paginierung
Begrenzen der Anzahl von Ressourcen pro Nutzdaten
Auswählen einer einzelnen Ressource in einer Sammlung
Paging über Ressourcen
Abrufen der Gesamtzahl der Ressourcen
Lernprogramm: GET mit den Parametern pageSize und totalCount senden
Verwenden von Abfrageparametern für eingeschlossene Ressourcen
Angeben von Abfrageparametern, die für eine eingeschlossene Ressource gelten
Zusammenfassung der Abfrageparameter für eingeschlossene Ressourcen
Lernprogramm: GET mit Abfrageparametern für eingeschlossene Ressourcen senden
POSTs und Anforderungs-Nutzdatenstrukturen
Übersicht über POSTs
Standardisierung von Nutzdatenstrukturen
Anzeigen von Anforderungsschemas
Anforderungsschema in der Swagger-Benutzeroberfläche anzeigen
Entwerfen von Anforderungs-Nutzdaten
Ermitteln der erforderlichen, optionalen und schreibgeschützten Felder
Struktur der Nutzdaten anfordern
Festlegen von skalaren Werten in Anforderungs-Nutzdaten
Festlegen von Objekten in Anforderungs-Nutzdaten
Senden von POSTs
POST mit Postman senden
Lernprogramm: Neue Notiz erstellen, die nur Pflichtfelder angibt
Lernprogramm: Neue Notiz erstellen, die optionale Felder angibt
Antworten auf ein POST
Postman-Verhalten mit Umleitungen
POSTs für Geschäftsaktionen
Verbessern der POST-Leistung
PATCHs
Übersicht über PATCHs
Die PATCH-Nutzdatenstruktur
Entwerfen von Anforderungs-Nutzdaten
PATCHs und Arrays
Senden von PATCHs
PATCH mit Postman senden
Lernprogramm: PATCH von Aktivitäten
Antworten auf ein PATCH
PATCHs und verlorene Aktualisierungen
Postman-Verhalten mit Umleitungen
DELETEs
Übersicht über DELETEs
Lernprogramm: Löschen von Notizen
DELETEs und verlorene Aktualisierungen
Reduzierung der Anzahl der Aufrufe
Funktionen, die mehrere Anforderungen gleichzeitig ausführen
Vergleich von Funktionen, die mehrere Anforderungen ausführen
Bestimmen der zu verwendenden Funktion
Anforderungseinschluss
Syntax für einfache hierarchische Beziehungen
Syntax für benannte Verhältnisse
Zusätzliches Verhalten beim Einschließen von Anforderungen
Stapelverarbeitungsanforderungen
Optionale Unteranforderungsattribute
Syntax für Stapelanforderungen
Einfache Stapelanforderungen
Stapelverarbeitungsanforderungen mit Abfrageparametern
Stapelanforderungen mit Anforderungs-Nutzdaten
Stapelanforderungen mit unterschiedlichen Operationen
Angeben von Unteranforderungskopfzeilen
Festlegen des onFail-Verhaltens
Konfigurieren der maximalen Anzahl von Unteranforderungen
Zusammengesetzte Anforderungen
Erstellen zusammengesetzter Anforderungsaufrufe
Abschnitt requests
Verwenden von Variablen zum gemeinsamen Nutzen von Informationen über Unteranforderungen hinweg
Antworten auf die Unteranforderungen
Abschnitt selections
Fehlerbehandlung
Protokollierung
Beschränkungen für zusammengesetzte Anforderungen
Konfigurieren der maximalen Anzahl von Unteranforderungen
Vollständige Syntax für zusammengesetzte Anforderungen
Verlorene Aktualisierungen und Prüfsummen
Verlorene Aktualisierungen
Prüfsummen
Prüfsummen für PATCHs und POSTs für Geschäftsaktionen
Lernprogramm: PATCH einer Aktivität mit Prüfsummen
Lernprogramm: Eine Aktivität mithilfe von Prüfsummen zuweisen
Prüfsummen für DELETEs
Prüfsumme in einem Anforderungskopf mit Postman senden
Lernprogramm: Löschen einer Notiz mithilfe von Prüfsummen
Cloud-API-Header
HTTP-Header
Übersicht über Cloud-API-Header
Anforderung mit einem Cloud-API-Header über Postman senden
Verhindern doppelter Datenbanktransaktionen
Aufwärmen eines Endpunkts
Bearbeiten eines Aufrufs mit unbekannten Elementen
Validieren von Antwort-Nutzdaten anhand zusätzlicher Einschränkungen
Globalisierung
Festlegen von Sprache und Gebietsschema bei API-Anforderungen
Adressen und Gebietsschemata
Konfiguration des Adressgebiets
Geschäftsabläufe: PolicyCenter
Konten
Erstellen eines Kontos
Kontoinhaber
Hauptstandort
Vermittlernummer
Beispiel: Erstellen eines Kontos
Konten suchen
Policentransaktionen
Initiieren der Policentransaktion
Ändern des Jobs
Erstellen eines Angebots für den Job
Abschließen der Policentransaktion
Spartenspezifische Endpunkte
Antrag
Initiieren der Policentransaktion für den Antrag
Ändern des Antragsjobs
Erstellen eines Angebots
Abschließen des Antrags
Lernprogramm: Antrags-Policentransaktion
Ausstellung
Police ausstellen
Verlängerung
Police verlängern
Stornierung
Police stornieren
Policenänderung
Police ändern
Wiederinkraftsetzung
Setzen Sie die Police wieder in Kraft
Neuausstellung und Neuausstellung eines neuen Kontos
Neuausstellungstransaktion
Transaktion „Neuausstellung für ein neues Konto“
Nicht sequenzielle Konflikte
Identifizieren nicht sequenzieller Konflikte
Auflösen nicht sequenzieller Konflikte
Beispiel: Identifizieren und Lösen von nicht sequenziellen Konflikten
Aufhebungen
Anzeigen von Aufhebungsinformationen
Beispiel für Aufhebungs-Nutzdaten
Bearbeiten von Aufhebungen
Beispiel für die Bearbeitung von Aufhebungen
Anwenden von Änderungen auf eine Verlängerung
Policen- und Jobsuche
Angebotserstellung mit mehreren Versionen
Eigenschaften der Jobversion
Erstellen einer neuen Jobversion
Auswählen einer Jobversion
Arbeiten mit Jobversionen
Arbeiten mit Vorbehalten
Abfragen von Vorbehalten
Erstellen von Vorbehalten
Schließen von Vorbehalten
Arbeiten mit Produktdefinitionen
Arbeiten mit Annahmeproblemen
Annahmeproblemressourcen
Abrufen von Annahmeproblemen
Abrufen des Annahmeverlaufs
Erzeugen von Annahmeproblemen
Genehmigen von Annahmeproblemen
Ablehnen von Annahmeproblemen
Erneutes Öffnen von Annahmeproblemen
Sperren von Jobs für die Annahmeüberprüfung
Geschäftsabläufe: Framework-APIs
Arbeiten mit Aktivitäten
Abfragen von Aktivitäten
Erstellen von Aktivitäten
Zuweisen von Aktivitäten
Zuweisungsoptionen
Zuweisungsbeispiele
Abrufen empfohlener Beauftragter
Schließen von Aktivitäten
Zusätzliche Funktionen von Aktivitäten
Arbeiten mit Dokumenten
Übersicht über Dokumente
Abfragen von Dokumentinformationen
Abfragen von Dokumentmetadaten
Abfragen von Dokumentinhalten
Buchen von Dokumenten
Buchen von Dokumenten mit Postman
Patchen von Dokumenten
Löschen von Dokumenten
Arbeiten mit Notizen
Abfragen von Notizen
Erstellen von Konto-, Job- und Policennotizen
Zusätzliche Funktionen für Notizen
Arbeiten mit Benutzern
Abfragen von Benutzerinformationen
Abfragen von Benutzern
Abfragen von Benutzerrollen
Erstellen und Aktualisieren von Benutzern
Erstellen von Benutzern
Aktualisieren von Benutzern
Vollmachtsprofile für Underwriter
Abrufen von Informationen über Underwriting-Vollmachtsprofile
Zuweisen von Underwriting-Vollmachtsprofilen zu Benutzern
Erstellen, Aktualisieren und Löschen von Underwriting-Vollmachtsprofilen
Arbeiten mit Organisationen
Abfragen nach Organisationen
Erstellen von Organisationen
Aktualisieren von Organisationen
Arbeiten mit Vermittlernummern
Abfragen von Vermittlernummern
Erstellen von Vermittlernummern
Aktualisieren von Vermittlernummern
Verfügbarmachen von Vermittlernummern für externe Benutzer
Konfigurieren der Cloud-API
Erweitern von System-API-Ressourcen
Schemaorganisation
Erweitern von Schemadefinitionen
Erweiterungssyntax für Schemadefinitionen
Erweitern von Mappern
Erweiterungssyntax für Mapper
Erweitern von Updatern
Erweiterungssyntax für Updater
Lernprogramm: Ressourcen-Erweiterung erstellen
Bereitstellen von Feedback
Verschleierung von personenbezogenen Daten
Aufheben von personenbezogenen Daten
Maskieren von personenbezogenen Daten
APIs für Sparten
Generieren und Installieren von spartenspezifischen APIs
Generieren von spartenspezifischen APIs über APD
Generieren von spartenspezifischen APIs
Generieren von Vorlagen aus einem vorhandenen finalen Produkt
Erstellen einer Vorlage mit dem umgekehrten Vorlagengenerator
Installieren von spartenspezifischen APIs ohne Installieren anderer Artefakte
API-Codegen-Konfiguration
Anwenden von API-Codegen-Überschreibungen
API-Codegen-Konfigurationssyntax
Deaktivieren von Produktartefakten beim Testen
Bestimmen der zu verwendenden Produktartefakte
Deaktivieren der visualisierten Artefakte eines Produkts
Aktivieren der visualisierten Artefakte eines Produkts
Deaktivieren von installierten Artefakten eines Produkts
Verwalten von LOB-spezifischen APIs für Tests und Integration
Importieren einer Produktvorlage über die API
Abfragen von Produktvorlagen
Umschalten des aktiven Zustands eines visualisierten Produkts
Generieren von Code aus einem visualisierten Produkt
Löschen einer Produktvorlage