π Más información sobre Usuarios
Obtener todos los usuarios
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/usuarios?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- page: número de página (opcional). Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado (opcional). Por defecto 100 si no es proporcionado (valor máximo).
Respuesta:
Lista de usuarios.
Ejemplo:
{
"result": {
"count": "3",
"items": [
{
"codigo": "USU-01",
"nombre": "Juan",
"apellido": "Pérez",
"email": "juanperez@webered.com",
"lista_precios_codigo": "MINORISTA",
"telefono": "123456789",
"telefono_pais": "54",
"direccion": "",
"codigo_postal": "",
"localidad": "",
"provincia": "",
"pais": "",
"razon_social": "",
"cuit": ""
},
{
"codigo": "USU-02",
"nombre": "María",
"apellido": "López",
"email": "marialopez@webered.com",
"lista_precios_codigo": "MAYORISTA",
"telefono": "",
"telefono_pais": "",
"direccion": "",
"codigo_postal": "",
"localidad": "",
"provincia": "",
"pais": "",
"razon_social": "",
"cuit": ""
},
{
"codigo": "USU-03",
"nombre": "Homero",
"apellido": "Simpson",
"email": "hsimpson@webered.com",
"lista_precios_codigo": "MINORISTA",
"telefono": "",
"telefono_pais": "",
"direccion": "Avenida Siempreviva 742",
"codigo_postal": "",
"localidad": "Springfield",
"provincia": "",
"pais": "Estados Unidos",
"razon_social": "",
"cuit": ""
}
]
}
}
Obtener la cantidad de usuarios
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/usuarios/count?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Cantidad de usuarios en formato JSON.
Ejemplo:
{
"result": {
"count": "105"
}
}
Obtener un usuario
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/usuarios/{CODIGO USUARIO}?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Datos de un usuario.
Ejemplo:
{
"result": {
"item": {
"codigo": "USU-01",
"nombre": "Juan",
"apellido": "Pérez",
"email": "juanperez@webered.com",
"lista_precios_codigo": "MINORISTA",
"telefono": "",
"telefono_pais": "",
"direccion": "",
"codigo_postal": "",
"localidad": "",
"provincia": "",
"pais": "",
"razon_social": "",
"cuit": ""
}
}
}
Crear un usuario
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/usuarios?apikey={CLAVE DE API}
Método HTTP:
POST
Parámetros:
- codigo: código que se le asigna al usuario para poder identificarlo. Requerido.
- email: dirección de correo del usuario. Requerido. Utilizada junto con la clave para acceder a sus datos en la tienda online.
- clave: contraseña que el usuario debe ingresar para acceder a sus datos en la tienda online. Requerido. Debe tener una longitud de al menos 6 caracteres.
- lista_precios_codigo: código de la lista de precios que se le asignará al usuario. Requerido.
- nombre: nombre del usuario.
- apellido: apellido del usuario.
- telefono: número de teléfono sin el código de país.
- telefono_pais: código telefónico del país.
- direccion.
- codigo_postal.
- localidad.
- provincia.
- pais.
- razon_social.
- cuit.
Respuesta:
Cantidad de usuarios creados.
Ejemplo:
{
"result": {
"count": "1"
}
}
Borrar un usuario
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/usuarios/{CODIGO USUARIO}?apikey={CLAVE DE API}
Método HTTP:
DELETE
Parámetros:
- Ninguno.
Respuesta:
Cantidad de usuarios borrados.
Ejemplo:
{
"result": {
"count": "1"
}
}
Modificar un usuario
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/usuarios/{CODIGO USUARIO}?apikey={CLAVE DE API}
Método HTTP:
PUT
Parámetros:
- codigo: código que se le asigna al usuario para poder identificarlo..
- email: dirección de correo del usuario.
- clave: contraseña que el usuario debe ingresar para acceder a sus datos en la tienda online
- lista_precios_codigo: código de la lista de precios que se le asignará al usuario.
- nombre: nombre del usuario.
- apellido: apellido del usuario.
- telefono: número de teléfono sin el código de país.
- telefono_pais: código telefónico del país.
- direccion.
- codigo_postal.
- localidad.
- provincia.
- pais.
- razon_social.
- cuit.
Nota: los campos que no se quieran modificar no deben ser incluidos en el conjunto de datos.
Respuesta:
Cantidad de usuarios modificados.
Ejemplo:
{
"result": {
"count": "1"
}
}