2022/12/09 - Mise à jour trimestrielle des API REST publiques

L'écosystème Hive Fairways Dette fournit un certain nombre d'API REST publiques. Pour plus d'informations, veuillez consulter notre site officiel de documentation des API pour les développeurs : https://developer.financeactive.com/api.html.

La liste des API référencées dans cette documentation est la liste exhaustive des API publiques et prises en charge. Par conséquent, l'utilisation de tout endpoint en dehors de cette liste est considéré comme non prise en charge : cet endpoint pourra être modifié ou supprimé sans préavis. Veuillez noter également que ce type d'endpoint n'est pas présumé valide par notre processus QA.

Chaque fois qu'une nouvelle version d'une API publique est publiée, la version précédente de cette API reste prise en charge pendant un an avant de devenir totalement dépréciée et, par conséquent, non prise en charge. Il n'y a pas de limite quant au nombre de versions d'une même API pouvant être prises en charge à un moment donné si plusieurs versions sont publiées sur une courte période.

API ajoutées au 4ème trimestre 2002

Ci-dessous la liste des API ajoutées au 4ème trimestre 2022 pour Portail Garant :

  • Liste des demandes : /gp/api/v1/guarantors/{guarantor_id}/requests. Pour plus d'informations, cliquer ici.
  • Récupération d'un avenant : /gp/api/v1/guarantors/{guarantor_id}/amendments/{request_id}. Pour plus d'informations, cliquer ici.
  • Récupération d'une prorogation ou paiement : /gp/api/v1/guarantors/{guarantor_id}/extend-or-pays/{request_id}. Pour plus d'informations, cliquer ici.
  • Récupération d'une demande de garantie : /gp/api/v1/guarantors/{guarantor_id}/guarantee-requests/{request_id}. Pour plus d'informations, cliquer ici.
  • Récupération d'une mainlevée : /gp/api/v1/guarantors/{guarantor_id}/releases/{request_id}. Pour plus d'informations, cliquer ici.
  • Liste des clients : /gp/api/v1/guarantors/{guarantor_id}/clients. Pour plus d'informations, cliquer ici.
  • Liste des documents de la demande : /gp/api/v1/guarantors/{guarantor_id}/requests/{request_id}/documents. Pour plus d'informations, cliquer ici.
  • Récupération du contenu du document : /gp/api/v1/guarantors/{guarantor_id}/requests/{request_id}/documents/
    {document_id}/content. Pour plus d'informations, cliquer ici.
  • Liste des commentaires de la demande : /gp/api/v1/guarantors/{guarantor_id}/requests/{request_id}/comments. Pour plus d'informations, cliquer ici.

L'API suivante a été ajoutée au 4ème trimestre 2022 pour Dette :

  • Intégration des encours de facilité de caisses : /api/debt/v3/{account_code}/integrations/cash_facility_balance. Pour plus d'informations, cliquer ici.

ATTENTION : API dépréciées au 4ème trimestre 2022

Ci-dessous la liste des API dépréciées au 4ème trimestre 2022. Celles-ci sont cependant prises en charge jusqu'au 4ème trimestre 2023.

  • /api/debt/v3/{account_code}/integrations/xml-v3
  • /api/debt/v3/{account_code}/integrations/xml-v2
  • /api/debt/v3/{account_code}/integrations/xml-v1

Pour rappel, la version actuelle de la même API est la suivante : /api/debt/v3/{account_code}/integrations

ATTENTION : API atteignant la fin du cycle de dépréciation - Suppression possible sans préavis supplémentaire

Ci-dessous la liste des API déjà dépréciées et pouvant être supprimées sans préavis supplémentaire :

  • /api/debt/v3/{account_code}/transactions
  • /api/debt/v3/{account_code}/transactions/{transaction_id}
  • /api/debt/v4/{account_code}/transactions/{transaction_id}/cash-flows
  • /api/debt/v3/{account_code}/cash-flows
  • /api/debt/v3/{account_id}/indicators/spot
  • /api/debt/v3/{account_id}/indicators/periodic
  • /api/referential/v3/{account_code}/users/{user_id}/accounts
  • /api/referential/v3/{account_code}/organizations (GET)
  • /api/referential/v3/{account_code}/organizations/{organization_id} (GET)
  • /api/referential/v3/{account_code}/entities/{entity_id} (GET)
  • /api/referential/v3/{account_code}/organizations/{organization_id}/entities (GET)
  • /api/referential/v3/{account_code}/entities (GET)

Pour rappel, les versions actuelles de ces mêmes API sont les suivantes :

  • /api/debt/v4/{account_code}/transactions
  • /api/debt/v4/{account_code}/transactions/{transaction_id}
  • /api/debt/v5/{account_code}/transactions/{transaction_id}/cash-flows
  • /api/debt/v4/{account_code}/cash-flows
  • /api/debt/v4/{account_id}/indicators/spot
  • /api/debt/v4/{account_id}/indicators/periodic
  • /api/referential/v4/{account_code}/users/{user_id}/accounts
  • /api/referential/v4/{account_code}/organizations (GET)
  • /api/referential/v4/{account_code}/organizations/{organization_id} (GET)
  • /api/referential/v4/{account_code}/entities/{entity_id} (GET)
  • /api/referential/v4/{account_code}/organizations/{organization_id}/entities (GET)
  • /api/referential/v4/{account_code}/entities (GET)
Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0