API pour la récupération de données — Formulaires GC

English

Surveiller

Erreurs courantes

Il s’agit d’erreurs courantes qui s’appliquent généralement et sont les mêmes pour tous les chemins d’URL.

Code du statut Exemple de message Signification / comment corriger
401 Unauthorized Aucun jeton d’accès n’a été fourni.
401 Access token has expired Le jeton d’accès a expiré.
403 Forbidden Le jeton d’accès n’a pas pu être validé OU le renseignement “Form ID” est inaccessible avec le jeton d’accès fourni.
404 Not found L’URL de requête n’est pas valide.
429 Too many requests Reportez-vous à la limite du débit de l’API pour le nombre maximal.
500 Internal server error Une erreur interne est survenue durant le traitement de la requête.

Signalement d’erreurs et retours d’information

Nous nous attendons à ce que des fonctionnalités supplémentaires soient nécessaires pour que les données soient transmises avec succès aux systèmes cibles. Si vous rencontrez une erreur, veuillez soumettre un [ticket de support technique] (https://forms-formulaires.alpha.canada.ca/en/support) et nous travaillerons avec vous pour résoudre le problème. N’hésitez pas à nous faire part de vos commentaires sur la mise en œuvre jusqu’à présent - ce qui fonctionne et ce qui ne fonctionne pas. Vos commentaires contribuent à façonner directement le produit en éclairant nos décisions sur les questions les plus importantes.

Limite du débit de l’API

Les limitations en matière de requêtes API nous permet de gérer le trafic élevé et de maintenir la stabilité du système. Cela permettra d’éviter les situations de surcharge où trop de demandes sont traitées simultanément.

La limite des demandes d’API à partir d’un formulaire est de 500 demandes par minute par défaut. Si vous dépassez cette limite, vous obtiendrez une erreur 429 RateLimitError. Vous pouvez soit attendre et réessayer, ou demander une limite plus élevée pour votre formulaire. Si vous avez besoin d’une augmentation du nombre de requêtes API, veuillez contactez l’équipe de soutien et nous pourrons augmenter la limite à 1000 demandes par minute pendant certaine période de temps.

Vous pouvez obtenir des informations supplémentaires dans les en-têtes inclus dans la réponse de l’API :

  • X-RateLimit-Limit : la limite actuelle de demandes API pour votre formulaire par 60 secondes
  • X-RateLimit-Remaining : le nombre de demandes d’API restantes dans cet intervalle de 60 secondes
  • X-RateLimit-Reset : le moment où la limite sera réinitialisée au montant total de la limite
  • Retry-After : le temps en secondes à attendre avant d’envoyer une autre demande à l’API

À l’avenir, nous prévoyons que les limites d’API seront liées à différents cas d’utilisation ou types d’utilisation et nous essaierons de déterminer des limites plus appropriées par minute pour les demandes d’API.

Actualisation des clés API

L’actualisation d’une clé API peut devenir nécessaire si une clé est compromise. Les clés peuvent être révoquées et recrées, ce qui nécessite simplement une modification des paramètres demandés dans la demande.