Aperçu

Aperçu #

Le API peut être utilisé pour provisionner les clients et gérer les utilisateurs et PBX connexions. L'information ci-dessous décrit le format utilisé pour API demandes et réponses.

Emplacements des ressources et Base URL #

Selon la région, votre ~.Dimensions.~ , 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 pour tout API est illustrée ci-dessous :

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

p. ex.

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

API Interaction #

Le API exige l'utilisation de définitions de format Json pour le contenu de toute demande. Toutes les réponses seront retournées en 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 peuvent ne pas toujours être retournés

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

{
	« 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 » : « succès »,
	« timestamp » : »<timestamp in UTC>"
}

API Ressources #

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

Ressource Descriptif
Clients Gérer les dossiers des locataires d'un client. Créer, mettre à jour ou résilier des comptes clients.
Clients utilisateurs Gérer les utilisateurs d'un locataire. Ajouter des utilisateurs ou mettre à jour des rôles pour permettre l'accès au portail ou modifier les niveaux de licence.
Client PBX Profils Gérer PBX Connexions pour un locataire, fournir des renseignements sur la façon de se connecter à la ou aux plateformes de communication du client.
Profils des clients locataires Interroger les profils de locataires disponibles pour ce client.
Données de facturation Interroger les données de facturation mensuelle, y compris les factures en format PDF, les dossiers de données de service et, le cas échéant, le SCSC.

Chaque ressource offre les interfaces d'interaction suivantes :

Interface Descriptif
Obtenir tout Renvoie une collection de tous les éléments correspondant au type de ressource.
Obtenez... Renvoie une instance spécifique du type de ressource.
Créez... Crée une nouvelle instance d'un type de ressource.
Correctif... Met à jour une instance existante de type ressource.
Supprimer... Supprime une instance existante d'un type de ressource.