Aperçu

Aperçu #

Le API peut être utilisé pour provisionner des clients et gérer des utilisateurs et PBX Connexions. Les informations ci-dessous décrivent le format utilisé pour API demandes et réponses.

Emplacements des ressources et Base URL #

Selon la région où votre ~.Dimensions.~ instance se trouve dans, il existe différentes URL pour accéder aux ressources de l'API. Veuillez utiliser le tableau ci-dessous pour trouver la bonne base URL pour votre région.

Région Base URL
Australie / Nouvelle-Zélande https://api.au.myreports.cloud
Europe https://api.eu.myreports.cloud
Amérique du Nord https://api.na.myreports.cloud
Royaume-Uni https://api.uk.myreports.cloud

Une fois que vous avez identifié la base URL pour votre région, le format de n'importe quel API Les demandes sont indiquées ci-dessous :

{BASE_URL}/api/{VERSION}/{RESSOURCE}

Par ex.

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

API Interaction #

Le API nécessite l'utilisation de définitions de format Json pour le contenu de toutes les demandes. Toutes les réponses seront renvoyées au format Json à l'aide du modèle suivant :

{
	« données » : {
		<returned data>
	},
	« erreur » : <errorCode>,
	« message » : <message>,
	« statut » : <status>,
	« horodatage » : <timestamp UTC>
}
Hand Left warning
Certains champs ne sont pas toujours renvoyés

Si le données return est une collection, elle renverra un tableau avec la taille de la page.

{
	« page_size » : »<number of items>",
	« données » : [ {
			« 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 » : « succès »,
	« timestamp » : »<timestamp in UTC>"
}

API Ressources #

Le tableau suivant donne un aperçu des ressources API donne accès à :

Ressource Description
Clientèle Gérer les enregistrements de locataire d'un client. Créer, mettre à jour ou résilier des comptes clients.
Utilisateurs clients Gérer les utilisateurs d'un locataire. Ajoutez des utilisateurs ou mettez à jour des rôles pour autoriser l'accès au portail ou modifier les niveaux de licence.
Client PBX Profils Gérer PBX Connexions pour un locataire, fournir des informations sur la façon de se connecter à la ou aux plateformes de communication du client.
Profils de locataires du client Interrogez les profils de locataire disponibles pour ce client.
Données de facturation Interrogez les données de facturation mensuelles, y compris les factures PDF, les enregistrements de données de service et, le cas échéant, les CDRS.

Chaque ressource fournit les interfaces d'interaction suivantes :

Interface Description
Tout obtenir Renvoie une collection de tous les éléments correspondant au type de ressource.
Avoir... Renvoie une instance spécifique du type de ressource.
Créer... Crée une nouvelle instance d'un type de ressource.
Rapiécer... Met à jour une instance existante de type ressource.
Supprimer... Supprime une instance existante d'un type de ressource.