← Tous les connecteursCatalogue Pipedream · Outils de développement

Apiary

Apiary est une plateforme de conception, de développement et de documentation d’API. Cette source couvre la création, la récupération et la publication de blueprints, ainsi que la liste des options de sous-domaine.

Version texte de cette fiche

Connexion à vérifier dans Bruno4 actions0 déclencheurs de référence

Utilisation dans Bruno

Catalogue Pipedream : connexion du compte et droits nécessaires. Les actions réellement utilisables sont vérifiées dans Bruno lors de la connexion. Les déclencheurs sont documentés à titre de référence et ne sont pas activés automatiquement dans Bruno.

Exemples de demandes à Bruno

Ces exemples utilisent des noms et des données fictifs. Pour les essayer, connectez l’application et accordez les accès nécessaires. Bruno vous demandera de valider les actions qui l’exigent.

Créer un projet API pour un nouveau service interne

Je veux préparer la création d’un projet API pour le service fictif Inventaire Nord, afin de cadrer la documentation avant publication.

Résultat attendu

Un projet API créé, si les accès et les informations demandées sont disponibles au moment de l’exécution.

À préciser dans votre demande

  • Nom du projet API
  • Contexte métier du service
  • Compte ou espace Apiary visé
Sources de cet exemple

Récupérer le blueprint d’une API existante

Je veux récupérer le blueprint de l’API du client fictif Atelier Martin pour le relire avant une mise à jour de documentation.

Résultat attendu

Le blueprint de l’API demandée, si la ressource existe et si l’accès est disponible.

À préciser dans votre demande

  • Nom ou identifiant de l’API
  • Objectif métier: revue de documentation
  • Accès au projet API concerné
Sources de cet exemple

Publier un blueprint validé

Je veux publier le blueprint validé de l’API du client fictif Maison Lenoir après la relecture de l’équipe.

Résultat attendu

Un blueprint publié pour l’API ciblée, sous réserve des droits et des paramètres fournis.

À préciser dans votre demande

  • Blueprint à publier
  • Nom de l’API cible
  • Validation métier préalable
Sources de cet exemple

À savoir avant de commencer

  • Les actions portent sur des projets et des blueprints API.
  • La liste des options de sous-domaine est distincte des opérations de création ou de publication.
  • La fiche ne décrit pas de lecture de trafic, de versions ni de métriques.
  • Aucun déclencheur n’est documenté ici.

Pour connecter cette application

  • Rechercher Apiary dans Apps, puis vérifier la connexion et les droits proposés. Connexion indiquée par Pipedream : clé API.
  • Les actions possibles dépendent de votre compte et des accès accordés. Un abonnement à l’application peut être nécessaire.
  • Bruno demande votre confirmation avant de créer, modifier ou supprimer des données. Les actions proposées par un connecteur Bruno peuvent différer de celles du catalogue Pipedream.
  • Le nom anglais est conservé sous chaque action pour la retrouver dans Pipedream.

Actions proposées

  • Créer un projet API

    Crée un nouveau projet API dans Apiary.

    Nom d’origine : Create API Project
    Documentation Pipedream →
  • Récupérer un blueprint

    Récupère le blueprint d’une API donnée.

    Nom d’origine : Fetch Blueprint
    Documentation Pipedream →
  • Lister les options de sous-domaine API

    Renvoie les options disponibles pour le champ de sous-domaine API.

    Nom d’origine : List API Subdomain Options
    Documentation Pipedream →
  • Publier un blueprint

    Publie le blueprint d’une API donnée.

    Nom d’origine : Publish Blueprint
    Documentation Pipedream →

Déclencheurs répertoriés par Pipedream

Aucune action ou aucun déclencheur répertorié ici. Une connexion ne suffit pas à rendre une action disponible dans Bruno.

Source vérifiée le : Apiary sur Pipedream.