Consultas e informes

Listar proveedores

POST https://api.afer.pro/listarProveedores

Devuelve los proveedores de tu cuenta, paginados y con identificadores cifrados, con buscador.

El espejo de listarClientes en el lado de compras. Cada proveedor llega con su proveedorId cifrado, usable como filtro en consultarFacturasCompra.

Si tu cuenta forma parte de un grupo y tiene activada la cartera de proveedores compartida con la empresa matriz, el listado devuelve los proveedores de la matriz; la respuesta lo indica con cartera_compartida_matriz.

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.

`busqueda`string opcional	Texto libre. Busca en nombre fiscal, nombre comercial, CIF, código contable, teléfono y móvil.
`pagina`int opcional	Página a devolver. Por defecto `1`.
`por_pagina`int opcional	Resultados por página. Por defecto `100`, máximo `500`.

Ejemplo de petición

curl -X POST 'https://api.afer.pro/listarProveedores' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: afer_tk_TU_TOKEN' \
  -H 'X-API-SECRET: afer_sk_TU_SECRET' \
  -d '{
    "busqueda": "suministros"
}'

<?php

$data = [
  'busqueda' => 'suministros',
];

$ch = curl_init('https://api.afer.pro/listarProveedores');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    '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/listarProveedores', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': 'afer_tk_TU_TOKEN',
    'X-API-SECRET': 'afer_sk_TU_SECRET'
  },
  body: JSON.stringify({
      "busqueda": "suministros"
  })
});

const resultado = await respuesta.json();

Respuesta

200 · application/json

{
    "errorCode": 200,
    "errorMsg": "",
    "data": {
        "total_proveedores": 1,
        "pagina": 1,
        "por_pagina": 100,
        "num_paginas": 1,
        "cartera_compartida_matriz": false,
        "proveedores": [
            {
                "proveedorId": "aBc123XyZ…",
                "nombre_fiscal": "SUMINISTROS BALEAR SA",
                "nombre_comercial": "Suministros Balear",
                "cif": "A07998877",
                "codigo_contable": "40000045",
                "email": "pedidos@suministrosbalear.com",
                "telefono": "971555666",
                "movil": "",
                "direccion": "Polígono Son Castelló, 21",
                "poblacion": "Palma",
                "provincia": "Illes Balears",
                "pais": "España"
            }
        ]
    }
}