Aller au contenu principal

Requête API de démarrage rapide

Cette section vise à s’assurer que votre clé API fonctionne et que vous disposez du formatage requis pour envoyer une POST requête et recevoir une réponse, conformément à la convention REST API. Suivre les étapes ci-dessous pour envoyer une requête simple afin de trouver le niveau d’emploi au Canada.

Authentification​

L'API du Carrefour de données oblige les utilisateurs à authentifier chacune de leurs requêtes API avec leur propre clé d’API unique. Pour authentifier chaque requête API, vous devez ajouter l’en-tête suivant à votre requête et à toutes les requêtes futures :

'x-api-key': 'API_KEY_HERE'

Pour localiser votre clé API unique, qui est associée à votre compte bac à sable :

Point de terminaison, indicateur et chaînes de requête​

L'API a un point de terminaison :

https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi

Chaque requête doit contenir le paramètre de requête appelé «indicator», avec une valeur de 1 à 18. Ces valeurs font référence aux indicateurs fournis par l'API.

Pour trouver le niveau d'emploi au Canada (la géographie par défaut), saisissez la chaîne de requête suivante :

https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=1

Deux autres paramètres importants sont le début et la fin, qui spécifient les dates d'intérêt. Pour consulter le niveau d'emploi en 2022-03-01, modifiez la chaîne de requête suivante :

https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=1&start=20220301&end=20220331

Tous les autres paramètres sont également transmis à l'API sous forme de chaînes de requête. Consultez les autres pages d'exemples pour vous familiariser.

Aperçu des requêtes et des réponses​

L'exemple suivant est une demande POST simple au format CURL :

curl --location --request POST 'https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=1' \
--header 'x-api-key: API_KEY_HERE' \
--data-raw ''

La réponse API :

 {
     "data": [
         {
             "source": "LFS-14100287; LFS-14100017",
             "as_of_date": "2022-03-01",
             "ref_date": "2022-03-01",
             "data_frequency": "monthly",
             "country": "Canada",
             "provinces_territories": null,
             "cma_en": null,
             "economic_regions_en": null,
             "sex_en": "Both sexes",
             "age_en": "15 years and over",
             "noc_level": null,
             "noc_code": null,
             "noc_title_en": null,
             "naics_level": null,
             "naics_code": null,
             "naics_title_en": null,
             "adjustment_en": "unadjusted",
             "indicator_name_en": "Employment level",
             "indicator_value": 19275900.0
         }
     ],
     "meta": {
         "current_page": 1,
         "total_pages": 1,
         "per_page": 1000,
         "total_rows": 1
     }
 }

Points à connaître :​

  • Utilisez toujours les requêtes POST car les requêtes GET n'acceptent pas les filtres.

  • La réponse API est au format JSON et comporte deux éléments : les données et les métadonnées. Les données contiennent toutes les variables, étiquettes et valeurs associées aux données de l'IMT. Les métadonnées contiennent des informations sur la réponse paginée.

  • L'API est limitée à 1000 enregistrements par page, la pagination est donc nécessaire pour les réponses volumineuses.

  Naviguez vers les autres pages du Guide API pour vous familiariser davantage avec les requêtes API du Carrefour de données.