Créer un client

Créer un client #

Crée un locataire client

POST /v1.0/clients

Exemple #

Cette demande créera un nouveau Client avec les détails suivants :

  • Nom : « Nouveau client »
  • Description : « Ceci est mon nouveau client »
  • Référence : « ABC00001 »
  • Activé : false
  • Fuseau horaire : « America/Los_Angeles »,
  • Code du pays : « États-Unis »
  • PbxConnectionProfile
    • Crossbar API REST : « https://hostrest »
    • Blackhole API Websocket : « wss// :hostwebsocket »
    • ~.pbx.kazoo.name.~ AccountId : « accountid »
    • ~.pbx.kazoo.name.~ Clé API : « apikey »
    • monitorSubAccounts : Faux
  • sendNewUserEmail : Faux
  • sendConnectWelcomeEmail : Faux
  • Durée de la période d'essai : « 0 »

Demander # 

POST <https://api.uk.myreports.cloud/api/v1.0/customers> HTTP/1.1
Type de contenu : application/json
Accept-charges : Vrai
Autorisation : porteur {TOKEN}
Connexion : maintien en vie
{
	« nom » : « Nouveau client »,
	« description » : « Voici mon nouveau client »,
	« référence » : « ABC00001 »,
	« activé » : faux,
	« fuseau horaire » : « Amérique/Los_Angeles »,
	« countryCode » : « US »,
	« pbxConnectionProfile » : {
		« \_type » : « KazooPbxConnectionProfile »,
		« hôteRepos » : « http\://hostrest »,
		« hostWebsocket » : « wss// :hostwebsocket »,
		« accountId » : « accountid »,
		« apiKey » : « apikey »,
		« monitorSubAccounts » : faux
	},
	« sendNewUserEmail » : faux,
	« sendConnectWelcomeEmail » : faux,
	« Durée du procès » : « 0 »
}

Réponse # 

HTTP/1.1 201 Créé
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Lieu : <https://api.uk.myreports.cloud/api/v1.0/customers/{NEW_CUSTOMER_TENANT_ID}>
{
	« données » : {
		« id » : « {NEW_CUSTOMER_TENANT_ID} »,
		« name » : « Nouveau client »,
		« description » : « C'est mon nouveau client »,
		« enabled » : false,
		« parentTenantId » : « {PARENT_ACCOUNT_TENANT_ID} »
	},
	« status » : « succès »,
	« timestamp » : « 2019-01-01T10:00:00.6829447Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré 

HTTP/1.1 401 Non autorisé

Mauvaise demande (1) #

Lorsque vous demandez un essai et que votre compte revendeur n'a pas d'autorisation. 

HTTP/1.1 400 Requête incorrecte
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 149
{
	« error » : 400,
	« message » : « Les clients d'essai ne sont pas activés pour votre compte. »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Mauvaise demande (2) #

Lors de la demande d'un essai au-delà de la durée d'essai maximale configurée. 

HTTP/1.1 400 Requête incorrecte
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 149
{
	« error » : 400,
	« message » : « La période d'essai du client dépasse la durée maximale autorisée pour votre compte. »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}