Die System-APIs der Basiskonfiguration

Die Basiskonfiguration umfasst die folgenden System-APIs:

Name Beschreibung Pfad
Schadenfall API für Schadenfälle und schadenfallspezifische Objekte /claim/v1
Admin API für Verwaltungsobjekte /admin/v1
Test-Dienstprogramm

API für Tests während der Entwicklung

(Nur verfügbar, wenn ClaimCenter in der ci-test-Umgebung gestartet wird)

 /test-util/v1
Allgemein API für allgemeine InsuranceSuite-Plattformobjekte wie Aktivitäten und Notizen /common/v1
API-Liste Führt dynamisch die verfügbaren APIs auf /apis

Sie können den API-Pfad verwenden, um Metadaten über die API anzuzeigen. Dies wird im Detail im folgenden Abschnitt beschrieben.

Darüber hinaus gibt es einen Mindestsatz an APIs für ContactManager. Weitere Informationen finden Sie unter dem <appURL>/rest/apis-Endpunkt für ContactManager.

Cloud-API-Versionen

Anmerkung: Im folgenden Abschnitt wird definiert, was eine Nebenversion ist. Es wird nicht erwartet, dass Nebenversion „grundlegende Änderungen“ enthalten. Die Arten von Änderungen, die nicht unter die Definition von „grundlegende Änderungen“ fallen, werden im Schema-Abwärtskompatibilitätsvertrag beschrieben. Wenn Sie auf eine Kopie dieses Vertrags zugreifen möchten, wenden Sie sich an Ihren Guidewire-Vertreter.

Jede Version der Cloud-API hat eine Versionsnummer. Als Beispiel folgende Annahme: Es gab vier Versionen der System-APIs im Januar, April, Juli und Oktober eines bestimmten Jahres. Jede Version könnte dann die folgenden Versionsnummern haben:

  • Januar: 1.0.0
  • April: 1.1.0
  • Juli: 1.2.0
  • Oktober: 2.0.0

Nebenversionen und Hauptversionen

In zukünftigen Versionen wird erwartet, dass sich die System-API-Funktionalität ändert. Um diese Änderungen zu definieren und zu steuern, verwendet die Cloud-API Nebenversionen und Hauptversionen.

  • Eine Nebenversion ist eine Version der Cloud-API, in der die Funktionalität entweder mit der vorherigen Version identisch ist oder diese ergänzt.
  • Eine Hauptversion ist eine Version der Cloud-API, in der sich die Funktionalität gegenüber der vorherigen Version geändert hat.

Eine bestimmte Version der Cloud-API kann mehrere Versionen der APIs enthalten, von denen einige Nebenversionen und einige Hauptversionen sind.

Hauptversionen werden in API-Endpunktpfaden durch die „Endpunktpfadnummer“ angegeben. Dies ist die Zahl, die nach dem „/v“ erscheint. (In /common/v1/activities ist die Endpunktpfadnummer beispielsweise 1.) Wenn Guidewire Änderungen an einer API vornimmt, die nicht rein ergänzend sind, wird die geänderte API als Hauptversion betrachtet. Ihre Endpunktnummer wird um 1 erhöht.

Wenn eine Version der Cloud-API eine neue Hauptversion enthält, ist auch die vorherige Nebenversion enthalten. Die Nebenversion kann identisch mit der vorherigen Version sein, aber auch zusätzliche Änderungen aufweisen.

Als Beispiel folgende Annahme für die Versionen aus dem vorherigen Beispiel:

  • Die Cloud-API in der Januar-Version ist Hauptversion 1.
  • Die Cloud-API in der April-Version ist identisch oder ergänzend.
  • Die Cloud-API in der Juli-Version ist identisch oder ergänzend.
  • Die Cloud-API in der Oktober-Version enthält Änderungen an bestehenden Funktionen.

In diesem Fall enthalten die Januar-, April- und Juli-Versionen jeweils eine einzelne Version der APIs, deren Endpunkt „/v1“ enthält. Die Oktober-Version würde sowohl das API-Set „/v1“ als auch ein neues API-Set „/v2“ enthalten. Das wird in der folgenden Tabelle zusammengefasst:

Veröffentlichungsmonat Versionsnummer Im Vergleich zur vorherigen Version gilt für diese Version... Hauptversionen in dieser Version
Januar 1.​0.​0 ...​ist identisch oder ergänzend /common/v1
April 1.​0.​1 ...​ist identisch oder ergänzend /common/v1
Juli 1.​0.​2 ...​ist identisch oder ergänzend /common/v1
Oktober 2.​0.​0 ...​enthält Änderungen an bestehender Funktionalität

/common/v1 (identisch mit oder ergänzend zur Juli-Veröffentlichung) und

/common/v2 (enthält die geänderte Funktionalität)