Premiers pas

Utilisez Echo pour préparer une requête d'API, l'envoyer et comprendre la réponse. Ce guide concerne Windows et macOS. Pour Android et iOS, commencez par Echo sur mobile.

Installer Echo

Sous Windows, recherchez Gapfy Echo dans le Microsoft Store, installez l'application et ouvrez-la depuis Démarrer. Sur un Mac avec Apple silicon, téléchargez le programme d'installation, ouvrez le fichier .pkg et terminez l'installation. Ouvrez ensuite Echo depuis Applications. Ce téléchargement est destiné aux Mac avec puce Apple, y compris les iMac compatibles ; il n'installe pas de version Intel.

Choisir comment commencer

Le mode invité permet d'enregistrer requêtes, collections et environnements sur votre ordinateur sans créer de compte. La base de données est chiffrée, avec une clé protégée par Windows DPAPI ou le Keychain de macOS. Vous pouvez modifier le travail enregistré sans connexion. Appeler une API distante exige toujours un accès à cette API.

Connectez-vous dans votre navigateur habituel pour synchroniser votre travail, utiliser des collections partagées et sélectionner une organisation. Vérifiez l'espace de travail actif avant de créer du contenu partagé. Les fonctions cloud dépendent des autorisations et de l'offre du compte. Consultez collections et partage.

Envoyer et enregistrer une première requête

  1. Créez un espace pour le projet, puis une collection dans cet espace.
  2. Ajoutez une requête HTTP avec un nom reconnaissable, comme List orders.
  3. Choisissez la méthode et saisissez l'URL de l'API. Ajoutez paramètres de requête et en-têtes dans leurs éditeurs. Pour POST ou PUT, choisissez le format de corps accepté par l'API.
  4. Configurez l'authentification si nécessaire. Préférez une variable d'environnement à un jeton collé dans l'URL.
  5. Sélectionnez l'environnement et envoyez. Vous pouvez annuler une exécution en cours.
  6. Consultez le statut, les en-têtes et le corps de la réponse. La vue des durées distingue connexion, attente du serveur et téléchargement de la réponse.
  7. Enregistrez la requête dans la collection. Une entrée d'historique ne remplace pas une requête enregistrée que vous souhaitez maintenir.

Commencez par une opération de lecture sur une API que vous pouvez appeler sans risque. Une requête peut créer ou modifier des données. Découvrez les éditeurs dans requêtes et protocoles.

Adapter votre espace de travail

Utilisez la palette de commandes pour trouver des actions sans parcourir tous les menus. Ouvrez des requêtes dans des onglets ou répartissez-les dans quatre panneaux au maximum pour comparer des appels liés. Les filtres de l'historique permettent de retrouver les exécutions précédentes et leurs détails.

Les paramètres proposent des thèmes clair, sombre et système, des couleurs d'accent et sept langues d'interface. Le site web propose six langues. Redémarrez Echo lorsque le changement de langue le demande. La section des raccourcis permet de modifier les touches et de restaurer les valeurs par défaut.

Les préférences contrôlent aussi la restauration des onglets et les valeurs par défaut des nouvelles requêtes : délai, validation des certificats et redirections. Vérifiez chaque requête pour définir une exception. Proxy et certificats client sont expliqués dans requêtes et protocoles.

Reprendre vos requêtes

Utilisez la section d'importation des paramètres pour les fichiers Postman, Insomnia, Bruno ou OpenAPI. L'assistant distinct d'importation cURL utilise l'IA et exige une licence Pro AI. Lisez l'aperçu et les avertissements avant de confirmer. Certains réglages et fichiers joints demandent une adaptation manuelle. Importation et exportation explique aussi les dossiers liés et la publication de documentation.

En cas de problème

Si une requête échoue, vérifiez l'environnement, l'URL résolue, l'authentification et la réponse. Si du contenu partagé manque, vérifiez le compte, l'espace de travail et l'état de synchronisation. Ses détails montrent l'activité récente et les actions pour les conflits ou les éléments à réparer.

Les paramètres affichent la version installée, les outils de diagnostic et la recherche de mises à jour si le canal d'installation la propose. Une recherche indisponible dans l'application ne signifie pas qu'une installation depuis le Store n'a aucune mise à jour. Pour contacter le support, notez la version et l'action en échec et retirez les identifiants des journaux partagés.

Réinitialiser la base de données du dispositif supprime les données de cet appareil. Exportez ce qui n'a pas encore été synchronisé avant d'envisager cette opération de récupération. Pour les erreurs habituelles de connexion ou d'autorisation, commencez par les détails de l'erreur.

Poursuivre votre travail