ApiCatcher
ApiCatcher

CLI

Version du document : 20261024

Disponible sur les applications de bureau macOS et Windows. iOS et Android n’ont pas cette commande. Ouvrez ApiCatcher avant de l’utiliser.

La CLI permet à une IA d’appeler les fonctions déjà présentes dans ApiCatcher, par exemple rechercher et analyser des requêtes HTTP, et gérer les scripts et les règles de réécriture.

Où se trouve la commande

Lancez-la dans le terminal du système. Sur macOS, c’est Terminal. Sur Windows, c’est l’invite de commandes ou PowerShell.

Sur macOS, la commande est dans l’application installée :

/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli tools

Si ApiCatcher n’est pas dans le dossier Applications, remplacez /Applications/ApiCatcher.app par l’emplacement de votre ApiCatcher.app.

Vous pouvez lui donner un nom court dans la fenêtre de terminal actuelle, puis taper apicatcher :

alias apicatcher="/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli"

Sur Windows, ouvrez le dossier où ApiCatcher est installé et lancez apicatcher-cli.exe. L’emplacement habituel est :

%LOCALAPPDATA%\Programs\ApiCatcher\apicatcher-cli.exe tools

L’icône ApiCatcher sur le bureau ouvre la fenêtre. Ce n’est pas cette commande.

Les exemples plus bas écrivent apicatcher. Utilisez le chemin complet sur votre ordinateur.

L’application doit être ouverte, avec le CLI activé

Le CLI est désactivé par défaut et n’occupe pas de port. Pour utiliser la commande :

  1. Ouvrez ApiCatcher.
  2. Ouvrez CLI dans la barre latérale et activez l’interrupteur.
  3. Quittez complètement l’application, puis rouvrez-la. C’est ce lancement qui accepte les commandes sur cet ordinateur.

Désactiver l’interrupteur n’arrête les commandes qu’au lancement suivant.

La commande échoue si l’application est fermée, si l’interrupteur est désactivé, ou si vous ne l’avez pas relancée après avoir changé l’interrupteur.

Commandes

Afficher les outils et les paramètres de cette version. C’est cette sortie qui fait foi.

apicatcher tools

Appeler un outil. --args est un objet JSON.

apicatcher call search_requests --args '{"host":"api.example.com","limit":10}'

L’objet peut aussi arriver sur l’entrée standard :

printf '%s' '{"host":"api.example.com"}' | apicatcher call search_requests

Sans --args, et si l’entrée standard est un terminal, les arguments valent {}.

apicatcher call get_capture_status

Sortie

La sortie standard contient un seul objet JSON. ok indique si l’appel a réussi. Si le résultat de l’outil est du JSON, il est placé dans result. Sinon, result reste une chaîne.

{"ok":false,"error":"ApiCatcher is not running"}

Paramètres courants de search_requests : keyword, search_target (url, host, req_header, resp_header, req_body, resp_body), method, host, status_code, file_type, session_id, limit, skip.

Sécurité

  • La commande ne fonctionne que sur cet ordinateur. Les autres appareils du réseau ne peuvent pas l’atteindre.
  • La sortie est du trafic réellement capturé et peut contenir des cookies, des jetons et des corps. Ne la publiez pas.