Effectuer une requête à l'api Particeep via la documentation interactive swagger

Pourquoi Swagger ?

Grâce à l'application Swagger vous pouvez :

  • envoyer des requêtes directement à notre API pour obtenir des informations liées à plusieurs paramètres de votre plateforme (comme des adresses emails par exemple).

⚠ AVERTISSEMENT : 

  • le Swagger est un outil à manier avec précision car il  impacte directement les informations liées à votre plateforme. 
  • Nous déconseillons formellement toute requête POST, PUT ou DELETE si vous utilisez une plateforme en marque blanche (cela peut désynchroniser des données avec la base de données complémentaire liée à la marque blanche).
  • Particeep se déresponsabilise en cas de changement ou perte d'informations liées à une action sur le Swagger autre qu'un GET et toute modification nécessitant une action de la part de Particeep sera facturée selon notre grille de services professionnels

Comment démarrer avec le Swagger ?

Comment connecter mon environnement Particeep sur Swagger ?

  • copiez votre clé présente dans l'URL back-office : 

  • ensuite, collez-la dans l'URL du Swagger : 

Vous pouvez faire des requêtes dans le swagger. 

Notez toutefois que mettre la clé dans l'URL ne suffit pas, il vous faut être logué dans l'espace administrateur back-office.

Obtenir des informations liées à un utilisateur 

Dans le Swagger, 

  • cliquez sur User (dans global service) :

  • Cliquez sur le premier GET "Get information about user with ID" (information de l'utilisateur avec l'identifiant de l'utilisateur).

  • Renseignez la référence d'un utilisateur associé à votre recherche

Comment une référence associée à un utilisateur  

Depuis votre Back-office administrateur 

  • Allez dans le menu utilisateur 
  • cliquez sur le petit symbole à gauche de la barre de recherche
  • cochez la case "référence", 
  • sélectionnez la référence et copiez la

  • collez-la référence dans le Swagger et cliquez sur "TRY IT OUT" : 

Le résultat obtenu sur l'utilisateur après la requête swaggerVous obtiendrez différents types d'informations comme

  • l'adresse email 
  • la date de naissance
  • le nom
  • le prénom
  • .....toutes les autres informations qui concernent le profil d'un utilisateur.

Obtenir des informations liées à une opération

Dans le Swagger, 

  • cliquez sur Fundraise (dans la rubrique Funding). 
  • cliquez ensuite 
    • sur Fundraise Loan pour récupérer des informations d'opérations en dette et en titres obligataires
    • sur Fundrase Equity pour récupérer des informations d'opérations en parts de fonds ou en parts sociales (capital)
  • cliquez ensuite sur le premier GET "Get Find a Fundraise by ID"  pour récupérer les informations de l'opération sur la base de son identifiant

Comment une référence associée à une opération

Depuis votre Back-office administrateur 

  • allez dans le menu Opérations 
  • cliquer sur le menu déroulant "actions" de l'opération
  • cliquer ensuite sur "Editer les détails" ou "Éditer la fiche" suivant le statut de l'opération
  • copier le code présent dans L'URL comme dans l'exemple ci-dessous

Le code correspond à la clé de l'opération,  il sera toujours présent après le "fundraise/" dans l'URL
  • collez lde code dans le Swagger et cliquer sur " TRY IT OUT" : 

Le résultat obtenu sur l'opération après la requête swagger

Vous obtiendrez ainsi toutes les informations clés liées à l'opération

 

Obtenir des informations liées à une transaction

Dans le Swagger, 

  • cliquez sur le menu transaction
  • cliquez ensuite sur le premier GET  " Get information about transaction with ID" pour récupérer les informations de la transaction sur la base de son identifiant

Comment une référence associée à une opération

Depuis votre Back-office administrateur,

  • allez dans le menu transaction puis cliquez sur le petit symbole à gauche de la barre de recherche, 
  • cochez la case "référence", 
  • copiez et coller la reference. 
  • collez la réference dans le Swagger et cliquez sur "TRY IT OUT" : 

Le résultat obtenu sur la transaction après la requête swagger

Vous obtiendrez différents types d'informations : 
  • Le montant de la transaction
  • Le type d'investissement (prêt/capital)
  • La devise
  • Les frais
  • La référence du projet associé, et de l’émetteur
  • .....toute autre information relative à la transaction

Cela ne répond pas à votre problème ? Contactez-nous Contactez-nous