SDK

Le SDK Qualify CRM simplifie l'intégration de la gestion de leads dans vos applications. Disponible en JavaScript/TypeScript et PHP, il encapsule toutes les interactions avec l'API REST.

Fonctionnalités du SDK

Le SDK couvre l'ensemble des fonctionnalités de l'API Qualify CRM :

• Gestion des leads — création, lecture, mise à jour, suppression, export.
• Webhooks entrants — envoi de leads depuis vos formulaires.
• Analytiques — récupération des métriques de conversion et de performance.

Installation

Installez le SDK via votre gestionnaire de paquets :

1. JavaScript/TypeScript : npm install @qualify-crm/sdk (ou yarn add / pnpm add)
2. PHP : composer require qualify-crm/sdk
3. Initialisez le client avec votre clé API et l'identifiant de votre projet.

Quick start JavaScript / TypeScript

Exemple complet pour démarrer avec le SDK JS :

// JavaScript / TypeScript
import { QualifyCRM } from '@qualify-crm/sdk';

const crm = new QualifyCRM({
  apiKey: 'YOUR_API_KEY',
  projectId: 'YOUR_PROJECT_ID',
});

// Fetch leads
const { leads, total } = await crm.leads.list({ page: 1, limit: 20 });

// Create a lead
const lead = await crm.leads.create({
  firstName: 'Marie',
  lastName: 'Dupont',
  email: 'marie@example.com',
});

// Update lead status
await crm.leads.update(lead.id, { statusId: 'status-id' });

Quick start PHP

Exemple complet pour démarrer avec le SDK PHP :

<?php
// PHP SDK
require_once 'vendor/autoload.php';

use QualifyCRM\Client;

$crm = new Client([
    'apiKey'    => 'YOUR_API_KEY',
    'projectId' => 'YOUR_PROJECT_ID',
]);

// Fetch leads
$result = $crm->leads->list(['page' => 1, 'limit' => 20]);

// Create a lead
$lead = $crm->leads->create([
    'firstName' => 'Marie',
    'lastName'  => 'Dupont',
    'email'     => 'marie@example.com',
]);

echo 'Lead created: ' . $lead->id;

Gestion des erreurs

Le SDK lève des exceptions typées pour faciliter la gestion des erreurs :

• QualifyAuthError — token invalide ou expiré (HTTP 401).
• QualifyNotFoundError — ressource introuvable (HTTP 404).
• QualifyRateLimitError — trop de requêtes, réessayez dans quelques secondes (HTTP 429).