API REST
SoliCRM propose une API JSON sous /api/v1 pour les comptes, les contacts, les pistes, les opportunités et les requêtes.
Authentification
Créez un jeton dans Mes paramètres → Sécurité → Jetons API et envoyez-le comme jeton porteur (bearer token) :
curl -H "Authorization: Bearer scrm_…" https://crm.example.com/api/v1/accounts
Le jeton agit au nom de son utilisateur : les règles de partage et les champs réservés aux admins s’appliquent.
Points de terminaison
| Méthode | Chemin | Rôle |
|---|---|---|
| GET | /api/v1/:object | liste, du plus récent au plus ancien : recherche ?q=, date ISO ?updated_since=, ?page=, ?per= (100 maximum) |
| GET | /api/v1/:object/:id | un enregistrement |
| POST | /api/v1/:object | création |
| PATCH | /api/v1/:object/:id | modification des champs envoyés |
:object vaut accounts, contacts, leads, opportunities ou cases. Les champs personnalisés se lisent et s’écrivent par leur nom d’API (cf_…) ; les règles de validation, les règles de workflow et les flux s’exécutent comme dans l’application.
Exemple
curl -X POST https://crm.example.com/api/v1/leads \
-H "Authorization: Bearer scrm_…" -H "Content-Type: application/json" \
-d '{"last_name": "Lovelace", "company": "Analytical Engines", "rating": "Hot"}'
Les erreurs sont renvoyées sous la forme {"error": "invalid", "details": [{"field": …, "message": …}]} avec le statut 422.