Überblick #

Das API kann verwendet werden, um Eigenschaften auf Ihrem Konto zu verwalten. Die untenstehenden Informationen beschreiben das Format, das für Anfragen und Antworten API verwendet wird.

Ressourcenstandorte & Basis URL #

Je nach Region dein ~.Dimensions.~ Instanz befindet sich, gibt es verschiedene URLs zum Zugriff auf API-Ressourcen. Bitte verwenden Sie die untenstehende Tabelle, um die korrekte Basis URL für Ihre Region zu finden.

Sobald Sie die Basis-URL für Ihre Region identifiziert haben, wird das Format für alle API Anfragen unten dargestellt:

{BASE_URL}/api/{VERSION}/{RESOURCE}

z. B.

https://api.na.myreports.cloud/api/v1.0/contactdirectories

API Interaktion #

Die API erfordert die Verwendung von JSON Formatdefinitionen für den Inhalt aller Anfragen. Alle Antworten werden im Format JSON unter Verwendung der folgenden Vorlage zurückgegeben:

{
	"data": {
		<returned data>
	},
	"Fehler": <errorCode>,
	"Botschaft": <message>,
	"Status": <status>,
	"Zeitstempel": <timestamp UTC>
}

warning
Manche Felder werden nicht immer zurückgegeben

Wenn das data eine Sammlung ist, wird ein Array mit Seitengröße zurückgegeben.

{
	"page_size": "<number of items>",
	"data": [{
			"id": "90CE2CCE-5B90-424B-B502-55924F140A48",
		}, {
			"id": "ec52f7b1-1b74-498e-a49b-59b71022c3a1",
		}
	][{
			"id": "90ce2cce-5b90-424b-b502-55924f140a48",
		}, {
			"id": "ec52f7b1-1b74-498e-a49b-59b71022c3a1",
		}
	],
	"Status": "Erfolg",
	"Zeitstempel": "<timestamp in UTC>"
}

API Ressourcen #

Die folgende Tabelle gibt einen Überblick über die Ressourcen, auf die API Zugriff bietet:

Jede Ressource bietet folgende Schnittstellen für die Interaktion: