Consultar usuario por número de celular #
Este método permite encontrar un usuario en la base de datos de LeanCore a través de su número de celular.
URL del endpoint #
GET /user
Parámetros de entrada #
Parámetro Tipo Descripción phone string Número de celular del usuario
Encabezados #
Encabezado Valor Authorization Bearer {token} Content-Type application/json
Respuesta esperada #
El método devuelve una respuesta en formato JSON con los siguientes campos:
- En caso de éxito, la respuesta tendrá el código de estado 200 y contendrá los siguientes datos:
{
"id": "string",
"image": "string",
"name": "string",
"lastname": "string",
"business_name": "string",
"quota": 0,
"status": "string",
"phone": "string",
"email": "string",
"nit": "string",
"address": "string",
"history": [],
"score": 0.0,
"payment_data": {},
"apn_token": "string",
"ecosystem": "string",
"business_entity": "string",
"additional_data": {}
}
Donde:
id: ID del usuario.image(opcional): URL de la imagen asociada al usuario.name: Nombre del usuario.lastname: Apellido del usuario.business_name: Nombre de la empresa del usuario.quota: Cuota del usuario.status: Estado del usuario.phone: Número de teléfono del usuario.email: Dirección de correo electrónico del usuario.nit: NIT del usuario.address: Dirección del usuario.history(opcional): Historial del usuario.score(opcional): Puntaje del usuario.payment_data(opcional): Datos de pago del usuario.apn_token(opcional): Token de APN (Apple Push Notification) asociado al usuario.ecosystem: Ecosistema del usuario.business_entity: Entidad empresarial del usuario.additional_data(opcional): Datos adicionales del usuario.
Ejemplos de uso #
Python #
import requests
url = "https://api.leancore.co/user"
headers = {
"Authorization": "Bearer <token>"
}
params = {
"phone": "573136434030"
}
response = requests.get(url, headers=headers, params=params)
if response.status_code == 200:
user = response.json()
print("Usuario encontrado:")
print(user)
else:
print("Error al consultar el usuario. Código de respuesta:", response.status_code)
print("Mensaje de error:", response.text)