Skip to content
RemindCash

Quickstart

Cree una clave de API, luego cree y lea su primer borrador de crédito en unos minutos.

Situación de la API pública

La API v1 utiliza las teclas de portador con un sistema operativo y requiere un período de plan activo. Los puntos finales de facturación y borrado no envían mensajes de clientes. Ejemplos usan los marcadores de posición — nunca pegan una clave real en código compartido.

Esta guía crea un borrador de crédito a través de la API y lo lee de nuevo. Nada se envía a su cliente.

1. Crear una clave de API

En la aplicación, abra Settings → Claves API y cree una clave con los alcances receivables:read y receivables:write.

  • Sólo la empresa owners y admins puede gestionar las llaves.
  • Su cuenta necesita un correo electrónico verificado y autenticación two-factor, y confirma su contraseña antes de gestionar las claves.
  • La clave se muestra once. Copiar a una tienda secreta; RemindCash mantiene sólo un hash.
  • Las llaves expiran después de 30 días. Ver Authentication para la rotación.

2. Mantenga la clave fuera de su código

BASH
export REMINDCASH_API_KEY="<your-api-key>"

3. Crear un proyecto de crédito

Cada escritura necesita una cabecera Idempotency-Key para que una solicitud retrigida nunca pueda crear un duplicado.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042",
    "description": "Website redesign"
  }'

La respuesta es 201 Created:

JSON
{
    "data": {
        "id": 1,
        "customer_id": 1,
        "amount_minor": 125000,
        "paid_minor": 0,
        "currency": "USD",
        "due_date": "2026-10-15",
        "status": "draft",
        "external_reference": "INV-1042",
        "description": "Website redesign",
        "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
    }
}

4. Léelo de nuevo

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

5. Activar en la aplicación

Abra el crédito en la aplicación, confirme los datos de contacto y permiso del cliente, revise el calendario de recordatorios y activelo. La activación no está disponible a través de la API.

Siguiente: Conceptos.