Claves de autenticación y API

Claves, alcances, requisitos del propietario clave, expiración, rotación y revocación.

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.

Llaves de oso

Envíe su llave en el encabezado Authorization de cada solicitud:

HTTP

GET /v1/receivables HTTP/1.1
Host: api.remindcash.com
Authorization: Bearer <your-api-key>
Accept: application/json

Solicitudes sin una clave válida 401 unauthenticated.

Scopes

Cada clave lleva uno o más ámbitos. Una solicitud fuera de los alcances de la llave devuelve 403 forbidden.

Ámbito	Sumas
`receivables:read`	`GET /receivables`, `GET /receivables/{id}`, `GET /reminder-attempts`
`receivables:write`	`POST /receivables`, `PATCH /receivables/{id}`, pagos, pausa, reanudar, cancelar
`usage:read`	`GET /usage`
`payables:read`	`GET /payables`, `GET /payables/{id}`
`payables:write`	`POST /payables`, `PATCH /payables/{id}`, `POST /payables/{id}/mark-paid`

Dar cada integración sólo los alcances que necesita.

¿Quién puede usar una llave?

Un acto clave en nombre de la persona que lo creó, dentro de una empresa. Cada solicitud comprueba que:

el correo electrónico del propietario clave se verifica y se confirma la autenticación two-factor,
el propietario clave es todavía un miembro activo de la empresa,
la propia empresa está activa.

Si falla algún cheque, la solicitud devuelve 403 forbidden. La eliminación de un miembro del equipo por lo tanto detiene sus llaves inmediatamente.

Creación, rotación y revocación de llaves

Las claves se gestionan en la aplicación bajo Settings → Claves API por propietarios y administradores de empresas con autenticación de dos factores.

Una nueva clave se muestra once; RemindCash almacena sólo un hash de él.
Las llaves expiran 30 días después de que se expidan.
Rotate emite una nueva clave con el mismo nombre y alcances y elimina el antiguo inmediatamente. Actualice su tienda secreta antes de girar.
Revoke elimina una clave de inmediato.
Cada persona puede mantener hasta 10 teclas activas por empresa.

Mantener las llaves seguras

Almacene claves en un gestor secreto o variable de entorno, nunca en el control de fuente o código frontal.
Utilice teclas separadas para sistemas separados para que pueda revocar uno sin afectar a los demás.
Si una clave puede haber filtrado, revocarla en Ajustes de inmediato.