Vue d'ensemble #

Le API peut être utilisé pour gérer les propriétés sur votre compte. 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 votre ~.Dimensions.~ instance se trouve dans, il existe différentes URL pour accéder aux ressources api. Veuillez utiliser le tableau ci-dessous pour trouver la bonne base URL pour votre région.

Une fois que vous avez identifié la base URL pour votre région, le format de tout API les demandes sont présentées ci-dessous :

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

p. ex.

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

API L'interaction #

Le API nécessite l'utilisation de JSON mettre en forme les définitions du contenu de toute demande. Toutes les réponses seront renvoyées dans JSON à l'aide du modèle suivant :

{
	« données » : {
		<returned data>
	},
	« erreur » : <errorCode>,
	« message » : <message>,
	« statut » : <status>,
	« horodatage » : <timestamp UTC>
}

warning
Certains champs peuvent ne pas toujours être renvoyés

Si le data retourné est une collection, il 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",
		}
	],
	« statut » : « succès »,
	« horodatage » : »<timestamp in UTC>"
}

API Ressources #

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

Chaque ressource fournit les interfaces suivantes pour l'interaction :