API pública · v2.0.0

Primeros pasos

API REST para integrar Clientify con sistemas externos: contactos, empresas, oportunidades, tareas, presupuestos, productos, pedidos, llamadas y más. Todas las rutas cuelgan de /v2/ y trabajan con JSON.

364operaciones

11apartados

158rutas

2.0.0Versión

URL base (producción)

https://api-plus.clientify.com

La referencia y el botón «Try it» de esta documentación usan el host que la sirve.

Recursos

Referencia de la API

Todas las operaciones, con parámetros, ejemplos y «Try it». Ahí está también la explicación de autenticación, filtros, errores y límites de petición.

Abrir la referencia

Esquema OpenAPI

Para Postman, Insomnia y generadores de código cliente.

Descargar JSON Descargar YAML

Autenticación

Todas las peticiones llevan tu API key en la cabecera Authorization. Se copia en Ajustes > API (hace falta ser administrador de la cuenta y tener el addon de API).

Ver mi API key

La API key da acceso completo a los datos de tu cuenta. Trátala como una contraseña: no la pegues en tickets, capturas ni repositorios.

Módulos de la API

Un módulo por tarjeta. Cada una abre la referencia filtrada a ese módulo.

Contactos 93 Las personas con las que hablas: su ficha completa con emails, direcciones, etiquetas y campos propios, sus teléfonos como lista aparte, y el alta masiva. Contacts · Contact Phones · Multiple Contacts Empresas 93 Las empresas y todo lo que cuelga de su ficha: personas de contacto, oportunidades, tareas y notas, con su catálogo de sectores. Companies Ventas 109 El ciclo de venta de principio a fin: oportunidades por embudo, presupuestos, pedidos, el catálogo de productos y el estado de las firmas. Deals · Budgets · Orders · Products · Electronic Signature Tareas y llamadas 25 El trabajo del equipo: tareas con sus tipos y estados, y el registro de llamadas con el contacto o la oportunidad a la que pertenecen. Tasks · Calls Marketing 17 Lo que sale hacia el cliente: campañas de email con su informe, las plantillas y sus carpetas, y los formularios de captación. Email · Templates · Campaigns · Web Marketing - Forms Inbox 8 Los canales del Team Inbox, sus conversaciones y sus mensajes, con el reenvío de cada mensaje a tu servidor. API Avanzada Inbox - Channels · Inbox - Conversations · Inbox - Messages Campos personalizados 8 Campos personalizados de la cuenta: definirlos y consultarlos, además de leer los valores que tienen guardados las fichas. Custom Fields Automatizaciones 2 Automatizaciones configuradas en la cuenta: qué automatizaciones hay y el detalle de cada una. Solo lectura. Automations Usuarios 1 Usuarios de la cuenta, para saber a quién se puede asignar un contacto, una oportunidad o una tarea. Solo lectura. Users Webhooks 6 Los avisos que Clientify manda a tu servidor cuando algo cambia: seis avisos fijos, uno por entidad. Se dan de alta y se borran, no se editan. Webhooks Integraciones 2 Las conexiones con herramientas de fuera y el estado de cada una, incluidas las de facturación y las de tiendas. Integrations