Authentification - Lovi AI Documentation

Introduction

Cette section fournit la documentation officielle pour l’authentification avec notre API via Postman. Elle comprend des instructions détaillées sur le processus d’authentification, les méthodes supportées et les bonnes pratiques pour garantir un accès sécurisé à l’API.

🔑 Authentification

Pour accéder à n’importe quel endpoint de l’API Lovi, vous devez d’abord vous authentifier et obtenir un token d’accès en utilisant votre email et votre mot de passe. Ce token doit ensuite être inclus dans l’en-tête Authorization de toutes les requêtes suivantes. Rotation des tokens : Nous recommandons de renouveler périodiquement les tokens et de les stocker de manière sécurisée.

Méthode : POST Format : JSON

Endpoint

POST https://cloud.lovi.ai/functions/v1/auth?grant_type=password

Paramètres de requête

Paramètre	Requis	Valeur fixe	Description
`grant_type`	Oui	`password`	Indique que vous utilisez l’authentification par email et mot de passe. C’est actuellement la seule méthode supportée.

En-têtes de requête

Informez le serveur du type de contenu que vous envoyez :

Clé	Valeur	Description
`Content-Type`	`application/json`	Indique que le corps de la requête est au format JSON.

Corps de la requête

C’est ici que vous fournissez vos identifiants personnels (votre email et mot de passe) :

{
  "email": "your-email@example.com",
  "password": "your-secure-password"
}

Vous devez remplacer :

“your-email@example.com” par votre adresse email réelle.
“your-secure-password” par votre mot de passe.

Réponse

Le serveur répondra avec un token que vous devrez utiliser pour vous authentifier dans les futurs appels API. La réponse ressemblera à ceci :

{
    "access_token": "your-access-token",
    "token_type": "bearer",
    "expires_in": 3600,
    "expires_at": 1744196340,
    "refresh_token": "bNYf6m7S7dFjfHCFTob2zg",
    "user": {
        "id": "3b601fa8-49fd-4a8c-af8c-b30601410975",
        "aud": "authenticated",
        "role": "authenticated",
        "email": "your-email@example.com",
        "email_confirmed_at": "2025-01-16T18:45:09.995114Z",
        "phone": "",
        "confirmed_at": "2025-01-16T18:45:09.995114Z",
        "last_sign_in_at": "2025-04-09T09:59:00.18987884Z",
        "app_metadata": {
            "provider": "email",
            "providers": [
                "email"
            ]
        },
        "user_metadata": {
            "email_verified": true,
            "name": "Your-Company"
        },
        "identities": [
            {
                "identity_id": "23b66c68-ce37-4483-8470-67e08e21a61e",
                "id": "3b601fa8-49fd-4a8c-af8c-b30601410975",
                "user_id": "3b601fa8-49fd-4a8c-af8c-b30601410975",
                "identity_data": {
                    "email": "your-email@example.com",
                    "email_verified": false,
                    "phone_verified": false,
                    "sub": "3b601fa8-49fd-4a8c-af8c-b30601410975"
                },
                "provider": "email",
                "last_sign_in_at": "2025-01-16T18:45:09.985377Z",
                "created_at": "2025-01-16T18:45:09.985932Z",
                "updated_at": "2025-01-16T18:45:09.985932Z",
                "email": "your-email@example.com"
            }
        ],
        "created_at": "2025-01-16T18:45:09.956743Z",
        "updated_at": "2025-04-09T09:59:00.192243Z",
        "is_anonymous": false
    }
}

⚠️ Sauvegardez votre access_token — vous l’utiliserez pour interagir avec le reste de l’API.

🧭 Récupérer les clés API de l’entreprise

Méthode : POST Format : JSON

Endpoint

POST https://cloud.lovi.ai/functions/v1/api_keys

En-têtes

Paramètre	Exemple	Requis	Description
Authorization	Bearer your-access-token	Oui	Cet en-tête est utilisé pour authentifier la requête. Il contient un token Bearer reçu après la connexion.

Réponse

Chaque objet dans le tableau validApiKeys représente une clé API associée à une entreprise spécifique. Les champs inclus sont :

company_id : Identifiant unique de l’entreprise propriétaire de la clé API.
key : La clé API elle-même, utilisée pour authentifier les requêtes.
is_active : Valeur booléenne indiquant si la clé est actuellement active (true) ou inactive (false).
last_used : Horodatage de la dernière utilisation de la clé. Si la clé n’a jamais été utilisée, la valeur sera null.
company_name : Nom de l’entreprise associée à la clé API, utile pour l’affichage dans les interfaces ou les journaux.

Voici un exemple :

{
    "validApiKeys": [
        {
            "company_id": "your_company_id",
            "key": "your_key",
            "is_active": true,
            "last_used": null,
            "company_name": "your_company_name"
        }
    ]
}

⚠️ Aucune clé API trouvée

Si la réponse retourne un tableau validApiKeys vide, cela signifie qu’aucune clé API n’a encore été créée pour votre entreprise. Exemple :

{
    "validApiKeys": []
}

Dans ce cas, vous devez aller dans le tableau de bord Admin et créer une nouvelle clé API pour votre entreprise.

Configuration des clés API depuis le 'Tableau de bord Admin'

Dans cette section, vous verrez comment configurer le profil et aussi comment configurer la clé API depuis le panneau.

🧭 Important : Sans une clé API valide et active, vous ne pourrez pas vous authentifier au niveau de l’entreprise ni effectuer d’opérations sécurisées.

Une fois la clé API créée et active, elle apparaîtra dans le tableau validApiKeys et pourra être utilisée pour générer un token au niveau de l’entreprise.

🔁 Token par entreprise

Une fois que vous avez identifié l’entreprise avec laquelle vous souhaitez travailler, vous devez vous authentifier à nouveau pour générer un token au niveau de l’entreprise. Cela est généralement requis pour les actions sécurisées comme l’envoi de notifications ou le téléchargement de médias. Vous utiliserez la key précédemment récupérée dans vos paramètres de requête ou en-têtes, selon l’endpoint.

Documentation API

Documentation Index

​Introduction