Obtener cliente

GET https://api.afer.pro/api/v1/customers/{id}

Alias en castellano (v0, sigue operativo): POST https://api.afer.pro/obtenerCliente

La ficha de un cliente por su identificador, con sus datos fiscales y su enlace al portal.

Los mismos campos que devuelve cada elemento de listarClientes, para cuando ya tienes el clienteId y no quieres paginar el listado entero.

Respeta la cartera compartida con la empresa matriz: si tu cuenta comparte clientes con la matriz, el cliente se busca allí y la respuesta lo indica con cartera_compartida_matriz.

tarifa es la tarifa de precios que se le aplica al facturar; el catálogo está en consultarTarifas.

Autenticación

Envía tus claves API en las cabeceras X-API-KEY y X-API-SECRET. La cuenta sobre la que se opera se resuelve automáticamente a partir de la clave. Cómo obtener tus claves →

Este endpoint requiere autenticación con API key: sin credenciales responde 401.

Parámetros del cuerpo

El cuerpo de la petición es un objeto JSON con Content-Type: application/json.

clienteIdstring

obligatorio

Identificador del cliente. Viaja en la ruta. Acepta el id cifrado de listarClientes o el numérico legacy.

Ejemplo de petición

curl -X GET 'https://api.afer.pro/api/v1/customers/aBc123XyZ?clienteId=aBc123XyZ' \
  -H 'X-API-KEY: afer_tk_TU_TOKEN' \
  -H 'X-API-SECRET: afer_sk_TU_SECRET'

<?php

$ch = curl_init('https://api.afer.pro/api/v1/customers/aBc123XyZ?clienteId=aBc123XyZ');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-KEY: afer_tk_TU_TOKEN',
    'X-API-SECRET: afer_sk_TU_SECRET',
]);

$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);

const respuesta = await fetch('https://api.afer.pro/api/v1/customers/aBc123XyZ?clienteId=aBc123XyZ', {
  method: 'GET',
  headers: {
    'X-API-KEY': 'afer_tk_TU_TOKEN',
    'X-API-SECRET': 'afer_sk_TU_SECRET'
  }
});

const resultado = await respuesta.json();

Respuesta

200 · application/json

{
    "errorCode": 200,
    "errorMsg": "",
    "data": {
        "cartera_compartida_matriz": false,
        "cliente": {
            "clienteId": "aBc123XyZ…",
            "nombre_fiscal": "FERRER INTERIORS SL",
            "nombre_comercial": "Ferrer Interiors",
            "cif": "B07123456",
            "codigo_contable": "4300012",
            "email": "admin@ferrerinteriors.com",
            "telefono": "971123456",
            "movil": "600123456",
            "direccion": "Carrer de la Mar, 12",
            "cp": "07001",
            "poblacion": "Palma",
            "provincia": "Illes Balears",
            "pais": "España",
            "fecha_alta": "2024-02-19",
            "tarifa": 1,
            "url_portal_cliente": "https://clientes.aferapp.com/miempresa/?loginToken=aBc123XyZ…"
        }
    }
}

Notas

Si el cliente no está en tu cartera responde 404.
url_portal_cliente llega a null si el tenant no tiene el portal configurado.