Autenticación

 

Autentica a un cliente determinado con la API y genera un token de autenticación para futuras solicitudes de API.

 

NOTA: el uso del token de autenticación es opcional, puede utilizar su ID de cliente y secreto en su lugar.

Si elige utilizar el token de autenticación en lugar de clientId y la autenticación secreta, reemplace los encabezados AuthClientId y AuthSecret con Authkey y configure el valor en el que devuelve este método.

Solicitar POST https://mi.dominio.com/servicio/authenticate

 

Campos:

Campo Tipo Descripción Obligatorio
ID de cliente Cadena ID de cliente de API, generado en la página de generación de claves Sí
secreto Cadena clave secreta, generada en la página de generación de claves Sí

 

Respuesta

Campo Tipo Descripción Obligatorio
autorización Cadena token de autenticación recién generado Sí
expira marca de tiempo (int) marca de tiempo de expiración del token Sí


Ejemplo de solicitud

 

 

#!/bin/bash

ID de cliente=”a153f7d88e51d5756dfecad0f9e27746″

secreto=”mi_secreto”

curl -X POST -d “clientId=${clientId}&secret=${secret}”

“https://mi.dominio.com/servicio/autenticación”

 

 

Ejemplo de respuesta 

{

 

“autenticación”: “<apiAuthenticationKey>”,

“caduca”: 1433438571

}

 

Crear usuario

 

URL de solicitud: https://my.domain.com/svc/users/createUser

Método de solicitud: POST

Datos de la solicitud:

Campo Tipo Descripción Obligatorio
nombre de host Cadena La URL del nombre de host. Sí
correo electrónico Cadena La dirección de correo electrónico designada por el usuario.
Debe ser válida.		 Sí
nombre de pila Cadena Nombre del usuario.
El campo no puede estar vacío ni tener más de 32 caracteres.		 Sí
apellido Cadena Apellido del usuario.
El campo no puede estar vacío ni tener más de 32 caracteres.		 Sí
cstid Cadena El ID del cliente externo (si existe) No
índice de lista de precios Int La posición de la lista de precios en la matriz (comenzando con nulo). Sí
correo electrónico de los padres Cadena El correo electrónico principal para configurar el usuario. No
establecerContraseñaPorCorreoElectrónico Booleano Elija si desea enviar la contraseña por correo electrónico o establecer una contraseña manualmente No
Nueva contraseña Cadena Una contraseña compleja Si se elige entonces Sí
verificar contraseña Cadena Verifique el campo de contraseña anterior.
Ambos campos deben coincidir.		 Si se elige entonces Sí
enviarCorreoElectrónicoDeValidación Booleano Elija si desea enviar al usuario una notificación de validación de correo electrónico No

 

Código de respuesta: 200

Datos de respuesta:

Campo Tipo Descripción Obligatorio
identificación entero El ID de cliente generado Sí

 

Ejemplos:

Solicitud POST https://mi.dominio.com/svc/users/createUser

{“nombre de host”: “mi.dominio.com”,

 

“correo electrónico”: “[email protected]”,

“nombre”: “Prueba”,

“apellido”: “Usuario”,

“cstId”: “”,

“índice de lista de precios”: nulo,

“parentEmail”: “[email protected]”,

“setPasswordByEmail”: verdadero,

"Nueva contraseña": "",

“verificarContraseña”: “”,

“sendValidationEmail”: verdadero

}

 

Código de respuesta: 200

Datos de respuesta:

{

 

“id”:1230768

}

 

Código de respuesta: 500

Datos de respuesta:

  • El correo electrónico ya está en uso.
 

 

{“errores”:[{“código”:104,”información”:”error al crear el usuario”,”categoría”:”Error general”}]}

 

  • La contraseña ingresada es muy fácil de hackear y no está permitida. Elija una nueva contraseña.
 

 

{“errores”:[{“código”:121,”información”:”error al crear el usuario”,”categoría”:”Error general”}]}

 

  • Su contraseña y contraseña de confirmación no coinciden.
 

 

{“errores”:[{“código”:106,”información”:”error en la verificación de contraseña”,”categoría”:”Error general”}]}

 

  • El correo electrónico del usuario no es válido.
 

 

{“errores”:[{“código”:107,”información”:”error al crear el usuario”,”categoría”:”Error general”}]}

 

  • El nombre no puede estar vacío ni tener más de 32 caracteres.
 

 

{“errores”:[{“código”:100,”información”:”error al crear el usuario”,”categoría”:”Error general”}]}

 

  • El apellido no puede estar vacío ni tener más de 64 caracteres.
 

 

{“errores”:[{“código”:101,”información”:”error al crear el usuario”,”categoría”:”Error general”}]}

 

Obtener lista de usuarios

 

URL de solicitud:

https://mi.dominio.com/usuarios/0?auxFilter=0&filter=&from=&hFrom=&hNItems=10&hNext=1&hSkip=0&nItems=500

Método de solicitud: GET

Solicitar datos: No se requieren datos del método


Código de respuesta: 200

Datos de respuesta:

Campo Tipo Descripción Obligatorio
identificación entero El ID del cliente Sí
dtCreate Cadena La fecha y hora de creación del usuario Sí
dtEjecutar Cadena El tiempo de ejecución de la transacción Sí
nombreDeServicio Cadena La dirección de correo electrónico del cliente Sí
commandInfo Cadena Título de la transacción Sí
código de salida entero Valor de 0 Sí
progreso entero Valor de 100 Sí
advertir Boolian El estado de advertencia del cliente Sí

 

Ejemplos:

Solicitud GET https://mi.dominio.com/usuarios/0?auxFilter=0&filter=&from=&hFrom=&hNItems=10&hNext=1&hSkip=0&nItems={resultAmount}

resultAmount – La cantidad de valores a devolver en la solicitud.

Datos de la solicitud:

Sin datos

Código de respuesta: 200
Datos de respuesta:

[{“id”: 761164688,

 

“dtCreate”: “2021-07-29 13:23:36”,

“dtExecute”: “2021-07-29 13:23:36”,

“dtComplete”: “2021-07-29 13:23:36”,

“nombreServicio”: “[email protected]”,

“commandInfo”: “Suspender cuenta de usuario”,

“Código de salida”: 0,

“progreso”: 100,

“advertir”: falso

}, {

“id”: 761154146,

“dtCreate”: “2021-07-29 13:02:50”,

“dtExecute”: “2021-07-29 13:02:50”,

“dtComplete”: “2021-07-29 13:02:51”,

“nombreDeServicio”: “[email protected]”,

“commandInfo”: “Subida del informe de uso 7/2021”,

“Código de salida”: 0,

“progreso”: 100,

“advertir”: falso

}]

 

 

 

 

Eliminar usuario

 

URL de solicitud: https://my.domain.com/svc/users/user/{userId}

{userId} – ID de usuario de CWM del usuario.

Método de solicitud: ELIMINAR

Datos de la solicitud: No hay datos


Código de respuesta: 200

No hay respuesta JSON del servidor.

 

 

Suspender usuario

 

URL de solicitud:

https://mi.dominio.com/svc/userOperations/{userId}/suspend

{userId} – ID del cliente

Método de solicitud: PUT

JSON que construye la ventana emergente con opciones seleccionables para el proceso:

 

 

{

    “OpcionesDeCuenta”: [[0, “OK”], [2, “Suspendido – Política”], [4, “Suspendido – Facturación”]],

    "estado": {

        “cuenta”: 0

    },

    “información”: {

        “correo electrónico”: “[email protected]”,

        “sitio”: “mi.dominio.com”,

        “cstId”: “”

    },

    “servicios”: []

}

 

 

Datos de la solicitud:

 

 

{

“ID del personal”: -1,

“estadoDeCuenta”: “2”,

"sujeto": "",

"contenido": "",

“servicios”: []

}

 

 

 

 

Campo Tipo Descripción Obligatorio
Identificación del personal Int   Sí
Estado de la cuenta Cadena El estado de la cuenta:

 

 

0 – OK

2 – Suspendido – Política

4 – Suspendido – Facturación

 

 Sí
sujeto Cadena Dejar en blanco Sí
Contenido Cadena Dejar predeterminado Sí
Servicios Formación Dejar predeterminado Sí


Código de respuesta: 200

Respuesta:

 

 

{

“cmdId”:761164688

}

 

 

Datos de respuesta:

El valor devuelto es el ID de la transacción y no es permanente.

Campo Tipo Descripción Obligatorio
id. de cmd entero El ID de la transacción Sí

 

 

Uso de exportación como CSV

 

URL de solicitud:

https://mi.dominio.com/svc/usageReport/csvUpload/{MES}_{AÑO}/Usuarios

{Mes} – Mes del Informe – en formato MM.

{Año} – Año del informe – en formato AAAA.

Método de solicitud:  POST

Datos de la solicitud:

Campo Tipo Descripción Obligatorio
Transacción Int 0 – Todas las transacciones

 

1 – Cada hora (por uso)

2 – Mensual parcial

3 – Mes completo mensual

4 – Anualmente

 Sí
Formato zip Booleano Manténgase fiel Sí

 

{

 

“transacción”: 0,

“zipFormat”: verdadero

}

Datos de respuesta:

Campo Tipo Descripción Obligatorio
id. de cmd Int ID de operación Sí
enlace Booleano Enlace temporal Sí

 

Ejemplo:

Código de respuesta: 200

Respuesta:

 

{

 

“cmdId”: 761148881,

Enlace: «https:\/\/filestore.cloudwm.com\/29-07-2021-gbtye2sr4ytsbbn3es4kkus823m1j72z\/UsageReport-self-All_Transactions-2021-07-01-2021-07-31.zip»

}

 
Was this answer helpful? 0 Users Found This Useful (0 Votes)