Zum Inhalt

Cliente

Resumen

Descripción Método Endpoint
- Crear cliente POST /hosting/api/client
-- Leer todos los clientes GET /hosting/api/client
- Leer clientes GET /hosting/api/client/{clientId}
- Actualizar cliente PUT /hosting/api/client/{clientId}
- Eliminar cliente DELETE /hosting/api/client/{clientId}
---- -Buscar clientes por nombre de usuario GET /hosting/api/client/by username/{username}
----- -Búsqueda de cliente por clave API GET /hosting/api/client/by apiKey/{apiKey}
- Client search (obsoleto) GET /hosting/api/clientgetid/{searchTerm}

-## Crear cliente {#create client}

Endpoint:/hosting/api/client

Método:POST

Carga útil:Cliente

Respuesta:

  • 201 - Recurso creado con éxito
  • Cliente
  • 400 - Propiedades no válidas o ausentes

--## Leer todos los clientes {#read all clients}

Endpoint:/hosting/api/client

Método:GET

Respuesta:

  • 200 - Éxito
  • Client[] - Específico de este endpoint, cada elemento contiene también las siguientes propiedades:
  • actualCallCount: int
  • domainCountData: Array.

-## Leer cliente

Endpoint:/hosting/api/client/{clientId}

Method:GET

Consulta:

  • {clientId}: -string - El ID de una cuenta de cliente CCM19

Respuesta:

  • 200 - Éxito
  • Cliente
  • 404 - Recurso no encontrado

-## Actualizar cliente {#update client}

Endpoint:/hosting/api/client/{clientId}

Método:PUT

Consulta:

  • {clientId}: -string - El ID de una cuenta de cliente CCM19

Carga útil:Cliente

Respuesta:

  • 200 - Éxito
  • Cliente
  • 400 - Propiedades no válidas o ausentes
  • 404 - Recurso no encontrado

-## Eliminar cliente {#delete client}

Endpoint:/hosting/api/client/{clientId}

Método:DELETE

Consulta:

  • {clientId}: -string - El ID de una cuenta de cliente CCM19

Respuesta:

  • 204 - Recurso eliminado con éxito
  • 404 - Recurso no encontrado

-- --<! heading id=haNWVGXx &gt --## Búsqueda de clientes por nombre de usuario {#client by username}

Endpoint: - /hosting/api/client/by username/{username}

Método:GET

Consulta:

  • {username}: cadena - nombre de usuario

Respuesta:

  • 200 - Éxito
  • Cliente
  • 404 - Recurso no encontrado

-- --<! heading id=rzAfTQ1O &gt ---## Cliente busca clave API {#cliente por apiKey}

Endpoint: - /hosting/api/client/by apiKey/{username}

Método:GET

Consulta:

  • {apiKey}: -string - Clave API

Respuesta:

  • 200 - Éxito
  • Cliente
  • 404 - Recurso no encontrado

-## Búsqueda de clientes (obsoleta) {#client search}

Endpoint:/hosting/api/clientgetid/{searchTerm}

Método:GET

Consulta:

  • {searchTerm}: --cadena - Nombre de usuario o dirección de correo electrónico

Respuesta:

  • 200 - Éxito
  • Cliente
  • 404 - Recurso no encontrado