Visão geral #

O API pode ser usado para gerenciar propriedades em sua conta. As informações abaixo descrevem o formato usado para API solicitações e respostas.

Locais de recursos e Base URL #

Dependendo da região, seu ~.Dimensions.~ instância estiver localizada, há URLs diferentes para acessar os recursos da API. Por favor, use a tabela abaixo para encontrar a base correta URL para sua região.

Depois de identificar a base URL para sua região, o formato para qualquer API solicitações é mostrado abaixo:

{BASE_URL}/api/{VERSÃO}/{RECURSO}

por exemplo,

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

API Interação #

O API requer o uso de JSON definições de formato para o conteúdo de quaisquer solicitações. Todas as respostas serão retornadas em JSON usando o seguinte modelo:

{
	"dados": {
		<returned data>
	},
	"erro": <errorCode>,
	"mensagem": <message>,
	"status": <status>,
	"carimbo de data/hora": <timestamp UTC>
}

warning
Alguns campos nem sempre podem ser retornados

Se o dados retornado é uma coleção, ele retornará uma matriz com o tamanho da página.

{
	"page_size": "<number of items>",
	"dados": [ {
			"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": "sucesso",
	"carimbo de data/hora": "<timestamp in UTC>"
}

API Recursos #

A tabela a seguir fornece uma descrição dos recursos que o API fornece acesso a:

Cada recurso fornece as seguintes interfaces para interação: