Zoho CRM
Accédez à l'API Zoho CRM avec authentification OAuth gérée. Gérez les prospects, contacts, comptes, affaires et autres modules CRM avec des opérations CRUD complètes, y compris la recherche et les opérations par lot. Prend également en charge les détails de l'organisation, la gestion des utilisateurs et la récupération des métadonnées des modules.
Démarrage rapide
# Lister les prospects
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
URL de base
https://gateway.maton.ai/zoho-crm/crm/v8/{endpoint}
La passerelle transmet les requêtes à www.zohoapis.com/crm/v8 et injecte automatiquement votre jeton OAuth.
Authentification
Toutes les requêtes nécessitent la clé API Maton dans l'en-tête Authorization :
Authorization: Bearer $MATON_API_KEY
Variable d'environnement : Définissez votre clé API comme MATON_API_KEY :
export MATON_API_KEY="YOUR_API_KEY"
Obtenir votre clé API
- Connectez-vous ou créez un compte sur maton.ai
- Allez dans maton.ai/settings
- Copiez votre clé API
Gestion des connexions
Gérez vos connexions OAuth Zoho CRM sur https://ctrl.maton.ai.
Lister les connexions
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections?app=zoho-crm&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Créer une connexion
python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'zoho-crm'}).encode()
req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Obtenir une connexion
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Réponse :
{
"connection": {
"connection_id": "e55c5bac-241a-4cc8-9db5-50d2cad09136",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=...",
"app": "zoho-crm",
"metadata": {}
}
}
Ouvrez l'url renvoyée dans un navigateur pour terminer l'autorisation OAuth.
Supprimer une connexion
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Spécifier une connexion
Si vous avez plusieurs connexions Zoho CRM, spécifiez laquelle utiliser avec l'en-tête Maton-Connection :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Maton-Connection', 'e55c5bac-241a-4cc8-9db5-50d2cad09136')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Si omis, la passerelle utilise la connexion active par défaut (la plus ancienne).
Référence de l'API
Modules
Zoho CRM organise les données en modules. Les modules principaux incluent :
| Module | Nom API | Description |
|---|---|---|
| Prospects | Leads | Clients potentiels |
| Contacts | Contacts | Personnes individuelles |
| Comptes | Accounts | Organisations/entreprises |
| Affaires | Deals | Opportunités de vente |
| Campagnes | Campaigns | Campagnes marketing |
| Tâches | Tasks | Éléments à faire |
| Appels | Calls | Journaux d'appels téléphoniques |
| Événements | Events | Rendez-vous du calendrier |
| Produits | Products | Articles que vous vendez |
Lister les enregistrements
GET /zoho-crm/crm/v8/{module_api_name}?fields={field1},{field2}
Paramètres de requête :
| Paramètre | Type | Description |
|---|---|---|
fields | string | Obligatoire. Noms des champs API séparés par des virgules (max 50) |
page | integer | Numéro de page (défaut : 1) |
per_page | integer | Enregistrements par page (défaut/max : 200) |
sort_by | string | Trier par : id, Created_Time ou Modified_Time |
sort_order | string | asc ou desc (défaut) |
cvid | long | ID de vue personnalisée |
page_token | string | Pour la pagination de >2000 enregistrements |
Exemple - Lister les prospects :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email,Phone,Company')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Réponse :
{
"data": [
{
"First_Name": "Christopher",
"Email": "[email protected]",
"Last_Name": "Maclead (Sample)",
"Phone": "555-555-5555",
"Company": "Rangoni Of Florence",
"id": "7243485000000597000"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"sort_by": "id",
"sort_order": "desc",
"more_records": false,
"next_page_token": null
}
}
Exemple - Lister les contacts :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Contacts?fields=First_Name,Last_Name,Email,Phone')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Exemple - Lister les comptes :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Accounts?fields=Account_Name,Website,Phone')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Exemple - Lister les affaires :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Deals?fields=Deal_Name,Stage,Amount')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Obtenir un enregistrement
GET /zoho-crm/crm/v8/{module_api_name}/{record_id}
Exemple :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads/7243485000000597000')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Créer des enregistrements
POST /zoho-crm/crm/v8/{module_api_name}
Content-Type: application/json
{
"data": [
{
"field_api_name": "value"
}
]
}
Champs obligatoires par module :
| Module | Champs requis |
|---|---|
| Prospects | Last_Name |
| Contacts | Last_Name |
| Comptes | Account_Name |
| Affaires | Deal_Name, Stage |
| Tâches | Subject |
| Appels | Subject, Call_Type, Call_Start_Time, Call_Duration |
| Événements | Event_Title, Start_DateTime, End_DateTime |
Exemple - Créer un prospect :
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"Last_Name": "Smith",
"First_Name": "John",
"Email": "[email protected]",
"Company": "Acme Corp",
"Phone": "+1-555-0123"
}]
}).encode()
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Réponse :
{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2026-02-06T01:10:56-08:00",
"Modified_By": {
"name": "User Name",
"id": "7243485000000590001"
},
"Created_Time": "2026-02-06T01:10:56-08:00",
"id": "7243485000000619001",
"Created_By": {
"name": "User Name",
"id": "7243485000000590001"
}
},
"message": "record added",
"status": "success"
}
]
}
Exemple - Créer un contact :
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"Last_Name": "Doe",
"First_Name": "Jane",
"Email": "[email protected]",
"Phone": "+1-555-9876"
}]
}).encode()
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Contacts', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Exemple - Créer un compte :
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"Account_Name": "Acme Corporation",
"Website": "https://acme.com",
"Phone": "+1-555-1234"
}]
}).encode()
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Accounts', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Mettre à jour des enregistrements
PUT /zoho-crm/crm/v8/{module_api_name}
Content-Type: application/json
{
"data": [
{
"id": "record_id",
"field_api_name": "updated_value"
}
]
}
Exemple :
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"id": "7243485000000619001",
"Phone": "+1-555-9999",
"Company": "Updated Company Name"
}]
}).encode()
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads', data=data, method='PUT')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Réponse :
{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2026-02-06T01:11:01-08:00",
"Modified_By": {
"name": "User Name",
"id": "7243485000000590001"
},
"Created_Time": "2026-02-06T01:10:56-08:00",
"id": "7243485000000619001",
"Created_By": {
"name": "User Name",
"id": "7243485000000590001"
}
},
"message": "record updated",
"status": "success"
}
]
}
Supprimer des enregistrements
DELETE /zoho-crm/crm/v8/{module_api_name}?ids={record_id1},{record_id2}
Paramètres de requête :
| Paramètre | Type | Description |
|---|---|---|
ids | string | IDs d'enregistrements séparés par des virgules (obligatoire, max 100) |
wf_trigger | boolean | Exécuter les workflows (défaut : true) |
Exemple :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads?ids=7243485000000619001', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Réponse :
{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "7243485000000619001"
},
"message": "record deleted",
"status": "success"
}
]
}
Rechercher des enregistrements
GET /zoho-crm/crm/v8/{module_api_name}/search
Paramètres de requête (un obligatoire) :
| Paramètre | Type | Description |
|---|---|---|
criteria | string | Critères de recherche (p. ex., (Last_Name:equals:Smith)) |
email | string | Recherche par adresse email |
phone | string | Recherche par numéro de téléphone |
word | string | Recherche textuelle globale |
page | integer | Numéro de page |
per_page | integer | Enregistrements par page (max 200) |
Format des critères : ((field_api_name:operator:value) and/or (...))
Opérateurs :
- Champs texte :
equals,not_equal,starts_with,in - Champs date/nombre :
equals,not_equal,greater_than,less_than,between,in - Champs booléens :
equals,not_equal
Exemple - Recherche par email :
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/zoho-crm/crm/v8/Leads/[email protected]')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Exemple - Recherche par critères :
python <<'EOF'
import urllib.request, os, json
import urllib.parse
criteria = urllib.parse.quote('(Last_Name:starts_with:Smith)')
req = urllib.request.Request(f'https://gateway.maton.ai/zoho-crm/crm/v8/Leads/search?criteria={criteria}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Réponse :
{
"data": [
{
"First_Name": "Christopher",
"Email": "[email protected]",
"Last_Name": "Maclead (Sample)",
"id": "7243485000000597000"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}
Détails de l'organisation
...