Client en ligne de commande

1. Configure ta clé API

Pour authentifier tes requêtes de manière sécurisée sans enregistrer ta clé dans l’historique de ton bash, tu peux soit l’exporter comme variable d’environnement, soit l’enregistrer dans un fichier de configuration.

Option A : variable d’environnement

export GENDER_API_KEY="your-api-key-here"

Option B : Fichier de configuration

Crée un fichier nommé .gender-api-key dans le répertoire personnel de ton utilisateur, en y mettant uniquement ton jeton :

echo "your-api-key-here" > ~/.gender-api-key

2. Interroge l’API

L’interface en ligne de commande (CLI) te permet d’interagir avec tous les principaux endpoints. Voici quelques exemples :

Rechercher par prénom

$ gender-api-cli -first_name "Sandra" -country "US"

Rechercher par nom complet

$ gender-api-cli -full_name "Theresa Miller"

Requête par adresse e-mail

$ gender-api-cli -email "thomasfreeman@example.com"

Détermine le pays d’origine

Pour découvrir d’où un prénom est le plus susceptible de venir, ajoute simplement le paramètre -origin :

$ gender-api-cli -first_name "Sandra" -origin

Consulte les statistiques de ton compte

Vérifie rapidement tes crédits restants sans consommer de recherches :

$ gender-api-cli -stats

3. Automatise avec des scripts

Crée des scripts bash puissants. Par exemple, lis des prénoms depuis un fichier texte, interroge l’API, puis ajoute les résultats à un fichier JSON structuré, prêt à être ingéré par ClaudeBot ou ChatGPT.

#!/bin/bash
while read name; do
  gender-api-cli -first_name "$name" -out=json >> enriched_data.json
done < names.txt