Criar cliente

Criar cliente #

Cria um novo locatário do cliente

POST /v1.0/clientes

Exemplo #

Esta solicitação criará um novo Cliente com os seguintes detalhes:

  • Nome: "Novo cliente"
  • Descrição: "Este é o meu novo cliente"
  • Referência: "ABC00001"
  • Habilitado: false
  • Fuso horário: "América/Los_Angeles",
  • Código do país: "US"
  • PbxConnectionProfile
    • Crossbar API Rest: "https://hostrest"
    • Blackhole API do websocket: "wss//:hostwebsocket"
    • ~.pbx.kazoo.name.~ AccountId: "accountid"
    • ~.pbx.kazoo.name.~ Chave 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 conteúdo: application/json
aceitar-encargos: verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
{
	"name": "Novo cliente",
	"description": "Este é meu novo cliente",
	"referência" : "ABC00001",
	"ativado": falso,
	"timezone": "América/Los_Angeles",
	"countryCode": "US",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsokcet",
		"accountId": "accountid",
		"apiKey": "apikey",
		"monitorSubAccounts": falso
	},
	"sendNewUserEmail": false,
	"sendConnectWelcomeEmail": false,
	"trialduration" : "0"
}

Resposta # 

HTTP/1.1 201 Criado
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
Localização: <https://api.na.myreports.cloud/api/v1.0/customers/{NEW_CUSTOMER_TENANT_ID}>
{
	"dados": {
		"id": "{NEW_CUSTOMER_TENANT_ID}",
		"name": "Novo cliente",
		"description": "Este é meu novo cliente",
		"ativado": falso,
		"parentTenantId": "{PARENT_ACCOUNT_TENANT_ID}"
	},
	"status": "sucesso",
	"timestamp": "2019-01-01T10:00:00.6829447Z"
}

Erros #

Desautorizado #

Quando o token não é fornecido, é inválido ou expirado 

HTTP/1.1 401 Não autorizado

Solicitação incorreta (1) #

Ao solicitar uma avaliação e sua conta de revendedor não tiver permissão. 

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro": 400,
	"message": "Os clientes de avaliação não estão habilitados para sua conta.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}

Solicitação incorreta (2) #

Ao solicitar uma avaliação além da duração máxima da avaliação configurada. 

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro": 400,
	"message": "A avaliação do cliente excede a duração máxima permitida para sua conta.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}