Überblick #

Die API kann verwendet werden, um Kunden bereitzustellen und Benutzer sowie PBX Verbindungen 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.

Region	Basis URL
Australien / Neuseeland	https://api.au.myreports.cloud
Europa	https://api.eu.myreports.cloud
Nordamerika	https://api.na.myreports.cloud
Vereinigtes Königreich	https://api.uk.myreports.cloud

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.uk.myreports.cloud/api/v1.0/customers

API Interaktion #

Die API erfordert die Verwendung von Json-Format-Definitionen für den Inhalt aller Anfragen. Alle Antworten werden im Json-Format mit folgender 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:

Ressource	Beschreibung
Kunden	Verwalten Sie Mieterdaten für einen Kunden. Kundenkonten erstellen, aktualisieren oder beenden.
Kundennutzer	Verwalten Sie die Benutzer für einen Mieter. Fügen Sie Benutzer hinzu oder aktualisieren Sie Rollen, um Zugriff auf das Portal zu ermöglichen oder Lizenzstufen zu ändern.
Customer PBX Profile	Verwalten Sie PBX Verbindungen für einen Tenant und geben Sie Informationen darüber, wie man sich mit den Kommunikationsplattformen des Kunden verbindet.
Kunden-Mieterprofile	Abfragen Sie die für diesen Kunden verfügbaren Mieterprofile.
Abrechnungsdaten	Abfrage monatlicher Abrechnungsdaten, einschließlich Rechnungen, PDFs, Servicedatendaten und, wo zutreffend, CDRS.

Jede Ressource bietet folgende Schnittstellen für die Interaktion:

Schnittstelle	Beschreibung
Macht alles	Gibt eine Sammlung aller Gegenstände zurück, die dem Ressourcentyp entsprechen.
Los...	Gibt eine bestimmte Instanz des Ressourcentyps zurück.
Erschaffe...	Erstellt eine neue Instanz eines Ressourcentyps.
Patch...	Aktualisiert eine bestehende Instanz des Ressourcentyps.
Löschen...	Entfernt eine bestehende Instanz eines Ressourcentyps.