Aller au contenu principal

Authentification

L'authentification à l'API Leadfox se fait avec un token JWT. Vous obtenez votre token en vous authentifiant avec une combinaison apikey & secret.

Générer une clé API et un secret​

Ouvrez l'application sur la page API, puis générez une nouvelle paire apikey & secret s'il n'en existe aucune. Le nom de domaine DNS n'a pas d'importance dans ce contexte et peut être ignoré. Vous pouvez par exemple utiliser le domaine de votre site web actuel, ou leadfox.co si vous voulez créer une nouvelle clé indépendante par sécurité.

remarque

Une apikey est liée au Client et partagée par tous les utilisateurs du Client.
Un secret est lié à l'utilisateur et sert à vous impersonner, comme si vous exécutiez l'action vous-même.
Vous êtes donc limité par votre propre Role dans le Client.

attention

Générer un nouveau secret révoque le précédent sans possibilité de retour.
Tout script automatisé qui utilise ce secret cessera de fonctionner.

Générer votre token JWT​

Pour générer votre token JWT, faites une requête POST sur l'endpoint /v1/auth/ avec votre apikey & secret en JSON dans le corps de la requête.

curl \
    --location 'https://rest.leadfox.co/v1/auth/' \
    --header 'Content-Type: application/json' \
    --data '{
        "apikey": "...",
        "secret": "..."
    }'
{
    "jwt": "ey...",
    "mode": "apikey",
    "client": "My Client Name",
    "clientid": "..."
}

Utiliser votre token JWT​

Une fois votre token JWT obtenu, utilisez-le pour authentifier vos requêtes à l'API Leadfox en l'incluant dans le header Authorization :

curl \
    --location 'https://rest.leadfox.co/v1/contact/' \
    --header 'Authorization: JWT <token>'
[
    {
        "_id": "string",
        "email": "string",
        // ...
    },
    // ...
]
info

Assurez-vous de laisser un espace entre JWT et votre token dans le header Authorization.