GetAff
Documentación de la API

La API de GetAff

Una API HTTP de servidor a servidor, de solo lectura, para consultar el directorio de programas y recuperar sus propias comisiones.

URL base
https://getaff.org/api
Version
v1 · 1.0.0

Qué puede hacer con ella

La versión 1 expone cuatro lecturas. No permite ninguna escritura: ni envío de programas ni cambios de cuenta. Es deliberado: una API de solo lectura no tiene modo de fallo destructivo, y preferimos publicar un contrato estrecho que mantendremos antes que uno amplio que tendríamos que retirar.

  • Recorrer el directorio público de programas, con filtros y paginación.
  • Leer la ficha de un programa concreto a partir de su identificador.
  • Conocer su plan, sus capacidades y sus plataformas conectadas.
  • Recuperar sus comisiones, filtradas por fecha, red y estado.

En tres pasos

  1. Inicie sesión y cree una clave desde la página «Claves de API». Se muestra una sola vez.
  2. Guárdela en el servidor, en un gestor de secretos o una variable de entorno.
  3. Envíela en cada llamada, en la cabecera Authorization.
Claves de API

Primera llamada

No hace falta ninguna otra cabecera. Las respuestas son siempre JSON en UTF-8.

curl
curl -s 'https://getaff.org/api/v1/programs?vertical=saas&minScore=60&limit=2' \
  -H 'Authorization: Bearer gaff_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Respuesta

200 OK
{
  "data": [
    {
      "slug": "northstack-northstack",
      "name": "NorthStack",
      "host": "northstack.io",
      "site": "https://northstack.io",
      "pitch": "Managed Postgres for teams that ship on Fridays. Free tier, usage billing.",
      "vertical": "saas",
      "model": "recurring",
      "commission": "25% recurring",
      "recurring": true,
      "cookieDays": 90,
      "payout": "monthly",
      "minPayout": 50,
      "markets": [
        "FR",
        "BE",
        "CH",
        "DE"
      ],
      "platform": "in-house",
      "signupUrl": "https://northstack.io/partners",
      "score": 78,
      "image": "",
      "createdAt": "2026-03-11T09:24:00.000Z"
    }
  ],
  "page": {
    "limit": 2,
    "hasMore": true,
    "nextCursor": "Wzc4LCJ2SzlxIl0"
  }
}

Paginación

Las colecciones se paginan por cursor, nunca por desplazamiento. Devuelva page.nextCursor tal cual en el parámetro cursor. El cursor es opaco: su contenido puede cambiar sin aviso, su significado no.

Versionado

La versión forma parte de la ruta. Mientras exista /v1, ningún campo desaparecerá de ella ni se añadirá ningún campo obligatorio: podemos añadir campos opcionales, nunca retirarlos. Una ruptura daría lugar a /v2, servida en paralelo. Escriba clientes que ignoren los campos que no conocen.

Especificación legible por máquina

El documento OpenAPI 3.1 se deriva de los mismos esquemas que aplican las rutas: no puede describir otra cosa que lo que realmente se valida. Úselo para generar un cliente.

Abrir la especificación OpenAPI
No desde un navegador

No se permite ningún origen de navegador, de forma deliberada. Una clave incrustada en el JavaScript de una página es una clave publicada. Llame a esta API desde su servidor, que es quien guarda la clave.

Toda esta documentación es pública

Aquí no se oculta nada: el contrato, los ejemplos y los límites se leen sin cuenta. Solo necesita una cuenta para emitir una clave y llamar a la API.

Cree una cuenta o inicie sesión
API — primeros pasos — GetAff