Documentation

Démarrage Rapide

Commencez avec l'API de Description d'Image IA en quelques minutes. Ce guide vous accompagnera à travers les étapes essentielles pour intégrer la description d'image alimentée par l'IA dans votre application.

Prérequis

Avant de commencer, assurez-vous d'avoir :

  • Compte : Inscrivez-vous sur aidescribepicture.com
  • Clé API : Créez une clé API dans les paramètres
  • Crédits : Achetez des crédits de description d'image
  • URL d'image : Une URL d'image publiquement accessible pour les tests

Étape 1 : Obtenez Votre Clé API

  1. Visitez aidescribepicture.com
  2. Connectez-vous avec votre compte Google
  3. Naviguez vers Paramètres > Clés API
  4. Cliquez sur le bouton "Créer une nouvelle clé API"
  5. Entrez un nom de clé (ex. "Mon App")
  6. Après avoir créé la clé, copiez la valeur complète de la clé (gardez-la en sécurité !)

Format de la Clé API

  • Commence par sk-
  • Contient des caractères générés aléatoirement
  • Exemple : sk-abc123def456ghi789...

Étape 2 : Faites Votre Premier Appel API

Utilisation de cURL

curl -X POST https://aidescribepicture.com/api/api-call/describe-picture \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "imageUrl": "https://example.com/image.jpg",
    "prompt": "Décrivez cette image en détail"
  }'

Utilisation de JavaScript

async function describeImage(imageUrl, apiKey, prompt = null) {
  try {
    const response = await fetch('https://aidescribepicture.com/api/api-call/describe-picture', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${apiKey}`
      },
      body: JSON.stringify({
        imageUrl: imageUrl,
        prompt: prompt
      })
    });
 
    if (!response.ok) {
      const error = await response.text();
      throw new Error(`Erreur API: ${response.status} - ${error}`);
    }
 
    const result = await response.json();
    
    // Extraire le contenu de la description
    const description = result.choices[0].message.content;
    return description;
  } catch (error) {
    console.error('Erreur lors de la description de l\'image:', error);
    throw error;
  }
}
 
// Utilisation
const description = await describeImage(
  'https://example.com/image.jpg',
  'your-api-key-here',
  'Décrivez cette image en détail'
);
console.log('Description de l\'image:', description);

Étape 3 : Gérer la Réponse

L'API retourne une réponse JSON avec la description de l'image :

{
  "choices": [
    {
      "message": {
        "content": "Cette image montre un renard roux en gros plan, face à la caméra. Le renard a une fourrure orange et blanche duveteuse, avec des oreilles dressées et des yeux bruns brillants. L'arrière-plan est flou, possiblement dans un environnement enneigé ou un cadre lumineux."
      }
    }
  ]
}

Le champ choices[0].message.content contient le texte de description d'image réel.

Étape 4 : Afficher le Résultat

En HTML

<div id="description">
  <p id="image-description"></p>
</div>

En JavaScript

// Afficher la description
const descriptionElement = document.getElementById('image-description');
descriptionElement.textContent = description;

Étape 5 : Gestion des Erreurs

Implémentez toujours une gestion d'erreur appropriée :

try {
  const description = await describeImage(imageUrl, apiKey, prompt);
  // Gérer le succès
  console.log('Description:', description);
} catch (error) {
  if (error.message.includes('401')) {
    console.error('Clé API invalide');
  } else if (error.message.includes('402')) {
    console.error('Crédits insuffisants');
  } else if (error.message.includes('429')) {
    console.error('Limite de taux dépassée');
  } else {
    console.error('Erreur API:', error.message);
  }
}

Gestion des Clés API

Gestion des Clés dans les Paramètres

  • Voir la liste de toutes les clés API
  • Voir les statistiques d'utilisation des clés
  • Désactiver ou supprimer les clés inutilisées
  • Voir la dernière heure d'utilisation des clés

Bonnes Pratiques de Sécurité

  • Ne jamais coder en dur les clés API dans le code côté client
  • Stocker les clés en utilisant des variables d'environnement
  • Faire tourner les clés API régulièrement
  • Utiliser des clés différentes pour différents environnements

Exemple de Variables d'Environnement

# fichier .env
IMAGE_DESCRIPTION_API_KEY=sk-your-api-key-here
// Utiliser dans le code
const apiKey = process.env.IMAGE_DESCRIPTION_API_KEY;