Base URL https://api.afer.pro Referencia aferapp.com Reservar demo

Comisionistas

GET https://api.afer.pro/api/v1/commission-agents
Alias en castellano (v0, sigue operativo): POST https://api.afer.pro/listarComisionistas

Los comisionistas de tu cuenta, para filtrar y asignar los documentos de venta por ellos.

Cada cliente y cada documento de venta (presupuesto, pedido, albarán, factura y recurrente) tiene dos comisionistas, los dos de esta misma lista:

  • Interno (comisionistaId): el de siempre, el que entra en las liquidaciones de comisión.
  • Externo (comisionistaExternoId): el colaborador de fuera que ha traído o acompaña la operación.

Al crear un documento sin indicarlos, los dos se heredan de la ficha del cliente. Las consultas de documentos (facturas, albaranes, presupuestos, pedidos y recurrentes) aceptan los dos como filtro y los devuelven en cada documento como comisionista y comisionista_externo (null si no tiene).

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.

buscarstring
opcional
Parte del nombre del comisionista.

Ejemplo de petición

curl -X GET 'https://api.afer.pro/api/v1/commission-agents' \
  -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/commission-agents');
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/commission-agents', {
  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": {
        "total_comisionistas": 2,
        "comisionistas": [
            {
                "comisionistaId": "cOm1…",
                "nombre": "Equipo comercial norte"
            },
            {
                "comisionistaId": "cOm4…",
                "nombre": "Agencia colaboradora"
            }
        ]
    }
}