Crear cliente

Crear cliente #

Crea un nuevo inquilino de cliente

POST /v1.0/clientes

Ejemplo #

Esta solicitud creará un nuevo Cliente con los siguientes detalles:

  • Nombre: "Nuevo cliente"
  • Descripción: "Este es mi nuevo cliente"
  • Referencia: "ABC00001"
  • Habilitado: falso
  • Zona horaria : "America/Los_Angeles",
  • Código de país: "US"
  • PbxConnectionProfile
    • Crossbar API de REST: "https://hostrest"
    • Blackhole API de Websocket: "wss//:hostwebsocket"
    • ~.pbx.kazoo.name.~ AccountId: "accountid"
    • ~.pbx.kazoo.name.~ Clave de API: "apikey"
    • monitorSubAccounts: Falso
  • sendNewUserEmail: Falso
  • sendConnectWelcomeEmail: Falso
  • TrialDuration: "0"

Pedir # 

POST <https://api.na.myreports.cloud/api/v1.0/customers> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: portador {TOKEN}
Conexión: keep-alive
{
	"name": "Nuevo cliente",
	"description": "Este es mi nuevo cliente",
	"referencia" : "ABC00001",
	"habilitado": falso,
	"timezone": "America/Los_Angeles",
	"countryCode": "US",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsokcet",
		"accountId": "accountid",
		"apiKey": "apikey",
		"monitorSubAccounts": falso
	},
	"sendNewUserEmail": falso,
	"sendConnectWelcomeEmail": falso,
	"trialduration" : "0"
}

Respuesta # 

HTTP/1.1 201 Creado
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
Ubicación: <https://api.na.myreports.cloud/api/v1.0/customers/{NEW_CUSTOMER_TENANT_ID}>
{
	"datos": {
		"id": "{NEW_CUSTOMER_TENANT_ID}",
		"name": "Nuevo cliente",
		"description": "Este es mi nuevo cliente",
		"habilitado": falso,
		"parentTenantId": "{PARENT_ACCOUNT_TENANT_ID}"
	},
	"status": "éxito",
	"timestamp": "2019-01-01T10:00:00.6829447Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado 

HTTP/1.1 401 No autorizado

Solicitud incorrecta (1) #

Al solicitar una prueba y su cuenta de revendedor no tiene permiso. 

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error": 400,
	"message": "Los clientes de prueba no están habilitados para su cuenta.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}

Mala solicitud (2) #

Al solicitar una versión de prueba más allá de la duración máxima de prueba configurada. 

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error": 400,
	"message": "La prueba del cliente supera la duración máxima permitida para su cuenta.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}