Aller au contenu principal

Suivi de redirection

Permet de spécifier pour une API ou ressource donnée, comment l'API gateway doit se comporter dans le cas d'une réponse de type redirection : retransmettre telle quelle la réponse ou suivre la redirection.

Cas d'usage

Certaines APIs répondent avec un status code de type 3.x.x indiquant une redirection. Cette fonctionnalité permet de faire suivre la requête vers une URL différente. Par défaut, la valeur est à true.

La fonctionnalité de suivi de redirection est notamment utilisée par les APIs suivantes :

  • API Digiposte PFM Auth v1
  • API Lin Authentification v1
  • API Export Adhésion Intégration v1
  • API Datanova v1
  • API Adhésion v2
  • API Adhésion Intégration v1
  • API Adhésion Intégration v2
  • API Gestprest Stream v1
  • API Code de la route v1
  • API Digiposte v3
  • API Digiposte PFM User v1

Principe de fonctionnement

Le suivi de redirection est porté par la clé followRedirect du namespace extra

  • followRedirect (boolean) : Permet de suivre une redirection (true). Dans le cas contraire, la réponse est renvoyée telle quelle.

Principe de mise en oeuvre

api:
name: My Api
urlContext: myapi
version: "1"
...
extra:
followRedirect: true