Obtener Clientes

GET /customer

Obtener Clientes Endpoint - Yativo

El endpoint "Obtener Clientes" es una parte crucial de nuestra API, diseñado para recuperar información detallada sobre los clientes almacenados en el sistema. Este endpoint proporciona una manera eficiente para que las aplicaciones accedan a los datos de los clientes para diversos propósitos, incluyendo mostrar perfiles de clientes, analizar la demografía de los clientes o integrarse con otros sistemas.

Características Clave:

• Método HTTP: GET

• URL del Endpoint: {{baseUrl}}/customer

• Autenticación: Requiere clave API o token OAuth para asegurar el acceso seguro.

Parámetros de Consulta:

• per_page (opcional): El número de página para resultados paginados.

Estructura de la Respuesta:

• Código de Estado: 200 OK en caso de éxito, con otros códigos indicando varios errores (por ejemplo, 401 No Autorizado, 404 No Encontrado).

Encabezados

Nombre	Valor
Content-Type	application/json
Authorization	Bearer <token>

Ejemplo de solicitud y respuesta

Python

import requests

url = "{{baseUrl}}/customer"

payload = {}
headers = {
  'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

PHP

<?php
$url = "{{baseUrl}}/customer";

$headers = array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9',
    'Content-Type: application/json'
);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

JavaScript

var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("{{baseUrl}}/customer", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Respuesta exitosa

200

{
    "status": "success",
    "status_code": 200,
    "message": "Records retrieved successfully",
    "data": [
        {
            "customer_id": "2f103e55-1dc5-40bd-a78c-a4574f7a50e6",
            "customer_name": "Test Customer",
            "customer_email": "[e-mail]",
            "customer_phone": "[phone]",
            "customer_country": "USA",
            "customer_address": {
                "city": "Anytown",
                "state": "Anystate",
                "zipcode": "12345",
                "street": "1234 Elm Street",
                "number": "5678",
                "country": "USA"
            }
        },
        {
            "customer_id": "3f103e55-1dc5-40bd-a78c-a4574f4a50e0",
            "customer_name": "Test Customer",
            "customer_email": "[e-mail]",
            "customer_phone": "[phone]",
            "customer_country": "USA",
            "customer_address": {
                "city": "Anytown",
                "state": "Anystate",
                "zipcode": "12345",
                "street": "1234 Elm Street",
                "number": "5678",
                "country": "USA"
            }
        }
    ],
    "pagination": {
        "total": 2,
        "per_page": 20,
        "current_page": 1,
        "last_page": 1,
        "next_page_url": null,
        "prev_page_url": null
    }
}

400

{
    "status": "error",
    "status_code": 400,
    "message": "Bad request. The request parameters are invalid or missing."
}

401

{
    "status": "error",
    "status_code": 401,
    "message": "Unauthorized. The API key is missing or invalid."
}