Passer au contenu
Dernière mise à jour

Démarrage rapide

Les exemples ci-dessous utilisent curl et une variable d’environnement. Avant de commencer, créez une clé avec les autorisations data:read et leads:write.

1. Enregistrer votre clé API

Les clés API ne sont affichées qu’une seule fois, lors de leur création dans Préférences → Accès API.

Collez la clé à l’invite ; l’option -s masque la valeur à l’écran et évite de l’inclure dans la commande elle-même.

read -s INSYDER_API_KEY
export INSYDER_API_KEY

Conservez la clé côté serveur. Ne l’ajoutez jamais à un dépôt, à une URL ou au code exécuté dans le navigateur.

2. Lister les comptes accessibles 

curl --request GET \
  --url https://api.insyder.io/v1/accounts \
  --header "X-API-Key: $INSYDER_API_KEY"

La réponse contient uniquement les espaces de travail sélectionnés pour la clé dont le propriétaire est toujours membre :

{
  "data": [
    {
      "account_id": "account_123",
      "username": "example_brand",
      "currency": "CHF",
      "role": "owner"
    }
  ],
  "meta": {
    "request_id": "req_123",
    "has_more": false,
    "next_cursor": null
  }
}

Conservez l’account_id pour les requêtes propres à un compte.

3. Lister les prospects 

curl --request GET \
  --url "https://api.insyder.io/v1/accounts/account_123/leads?limit=50" \
  --header "X-API-Key: $INSYDER_API_KEY"

Lorsque meta.has_more vaut true, transmettez meta.next_cursor sans le modifier dans la requête suivante :

curl --get \
  --url https://api.insyder.io/v1/accounts/account_123/leads \
  --header "X-API-Key: $INSYDER_API_KEY" \
  --data-urlencode "cursor=cursor_from_the_previous_response" \
  --data-urlencode "limit=50"

4. Mettre à jour un prospect

Seuls status, email, phone et notes peuvent être modifiés. Les champs omis restent inchangés ; envoyer null efface un champ géré par l’utilisateur qui accepte une valeur nulle.

curl --request PATCH \
  --url https://api.insyder.io/v1/accounts/account_123/leads/lead_456 \
  --header "Content-Type: application/json" \
  --header "X-API-Key: $INSYDER_API_KEY" \
  --data '{
    "status": "follow_up",
    "notes": "Requested a follow-up next week"
  }'

5. Gérer les limites et les erreurs

Les réponses réussies du routeur incluent X-Request-Id et les en-têtes de limitation. La limite est de 20 requêtes acceptées par fenêtre fixe d’une seconde UTC, toutes clés d’un même utilisateur confondues. Une requête dépassant cette limite renvoie 429 avec Retry-After.

Les erreurs utilisent application/problem+json. Lorsque vous contactez le support, conservez le X-Request-Id de la réponse, mais ne joignez jamais votre clé API ni de données sensibles de la requête.

Poursuivez avec l’authentification ou explorez la référence API complète.

Introduction

Authentification