API pública de Apropos
La API pública de Apropos permite que sus aplicaciones lean y administren mediante programación los clientes, las propuestas y los artículos del catálogo de su organización. Esto resulta útil si desea integrar Apropos con otras aplicaciones o procesos, por ejemplo, mediante Zapier, Make, n8n, Pabbly Connect y más.
Crear una clave de API
El acceso a la API requiere el plan Team, y solo los administradores de la organización pueden crear claves. En Configuración → Claves de API, haga clic en Crear clave y asígnele un nombre. El secreto sin procesar se muestra una sola vez; solo se almacena un hash, por lo que una clave perdida no se puede recuperar y debe revocarse y volver a crearse.
Autenticar solicitudes
Cada solicitud debe incluir una clave de API activa en el encabezado Authorization como token Bearer:
Authorization: Bearer ak_live_<secret>Las claves de API comienzan con el prefijo ak_live_, seguido de 64 caracteres hexadecimales. Las claves están vinculadas a su organización, y cada consulta de clientes, propuestas y artículos se limita a los datos de esa organización. La v1 no tiene ámbitos para las claves de API: una clave válida tiene acceso completo a la API pública de su organización.
Realizar su primera solicitud
Todas las rutas se sirven desde la URL base https://api.sendapropos.com/v1. Este ejemplo muestra una lista de sus clientes:
curl -H "Authorization: Bearer ak_live_..." \
"https://api.sendapropos.com/v1/customers"Todas las respuestas están en formato JSON. Cada clave de API está limitada a 100 solicitudes por cada 60 segundos; cuando se supera el límite, la API devuelve HTTP 429 con un encabezado Retry-After: 60.
Qué puede hacer con la API
La API pública abarca tres recursos. Cada endpoint tiene su propio artículo con detalles sobre las solicitudes y las respuestas:
Clientes — listar, consultar, crear y actualizar registros de clientes.
Propuestas — listar y consultar propuestas (solo lectura en la v1).
Artículos — listar, consultar y crear artículos del catálogo (sus productos y servicios).
Qué leer a continuación
Cada endpoint está documentado en su propio artículo dentro de esta sección de Referencia de la API, con la ruta exacta, el cuerpo de la solicitud, los parámetros y el formato de respuesta de esa operación.