Zum Inhalt

Cliente

Resumen

| Descripción del cliente | Método | Punto final | | ----------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------- | | Crear cliente | POST <nt>|</nt>/hosting/api/client<nt>|</nt> <nt>|</nt> [Leer todos los clientes](#read-all-clients) <nt>|</nt> gET <nt>|</nt> hospedaje/api/cliente <nt>|</nt> <nt>|</nt> [Leer clientes](#read-client) <nt>|</nt> gET <nt>|</nt>/hosting/api/client/{clientId}[Leer clientes <nt>|</nt> <nt>|</nt> [Actualizar cliente](#update-client) <nt>|</nt> pUT <nt>|</nt>/hosting/api/client/{clientId}[Actualizar cliente <nt>|</nt> <nt>|</nt> [Eliminar cliente](#delete-client) <nt>|</nt> dELETE <nt>|</nt>/hosting/api/client/{clientId}[Eliminar cliente <nt>|</nt> <nt>|</nt> [Buscar clientes por nombre de usuario](app.nuclino.com/t/b/66cffd96-7784-43d3-a948-fc1ca913b8bd#haNWVGXx) <nt>|</nt> gET <nt>|</nt> `/hosting/api/client/by-username/{nombre-deusuario} | | Búsqueda de clientes por clave API | gET | /hosting/api/client/by-apiKey/{apiKey}`` <nt>|</nt> <nt>|</nt> [Búsqueda de clientes](#búsqueda-de-clientes) (obsoleto) <nt>|</nt> gET <nt>|</nt>/hosting/api/clientgetid/{searchTerm}` [Búsqueda de cliente |

Crear cliente

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

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 clientes

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

Método:GET

Consulta:

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

Respuesta:

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

Actualizar cliente

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

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

Búsqueda de clientes por nombre de usuario

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

Método:GET

Consulta:

  • {username}: cadena - nombre de usuario

Respuesta:

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

Cliente busca clave API

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

Método:GET

Consulta:

  • {apiKey}: string - Clave API

Respuesta:

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

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