Visión general #

El API se puede utilizar para aprovisionar clientes y administrar usuarios y PBX Conexiones. La siguiente información describe el formato utilizado para API Solicitudes y respuestas.

Ubicaciones de recursos & Base URL #

Dependiendo de la región, su ~.Dimensions.~ se encuentra en, hay diferentes URL para acceder a los recursos de la API. Utilice la siguiente tabla para encontrar la base correcta URL para su región.

Una vez que haya identificado la base URL para su región, el formato para cualquier API solicitudes se muestra a continuación:

{BASE_URL}/api/{VERSIÓN}/{RECURSO}

p ej.

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

API Interacción #

El API requiere el uso de definiciones de formato Json para el contenido de cualquier solicitud. Las respuestas se devolverán en formato Json utilizando la siguiente plantilla:

{
	"datos": {
		<returned data>
	},
	"error": <errorCode>,
	"mensaje": <message>,
	"Estado": <status>,
	"Marca de tiempo": <timestamp UTC>
}

warning
Es posible que algunos campos no siempre se devuelvan

Si el datos returned es una colección, devolverá una matriz con el tamaño de página.

{
	"page_size": "<number of items>",
	"Datos": [ {
			"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": "éxito",
	"marca de tiempo": "<timestamp in UTC>"
}

API Recursos #

En la tabla siguiente se proporciona un resumen de los recursos que API Proporciona acceso a:

Cada recurso proporciona las siguientes interfaces para la interacción: