Services Web maintenant offerts par le Service hydrographique du Canada

Services Web donnant accès aux données officielles pour la navigation de courants de surface et niveaux d'eau modélisés.

Conditions d'utilisation du site Web public des marées, courants et niveaux d'eau

Si vous désirez utiliser les services Web offerts par le Service hydrographique du Canada et le site Web public des marées, courants et niveaux d'eau, veuillez lire le accord de licence.

Si vous acceptez les modalités du Service hydrographique du Canada et du contrat de licence du site Web public sur les marées, courants et niveaux d'eau, veuillez cliquer sur le bouton "J'accepte".

Sur cette page

Service Web donnant accès aux prédictions, observations, prévisions et autres informations aux stations de niveau d'eau (API IWLS)

Description

Le service Web du Système Intégré de Niveaux d'Eau (IWLS) a été développé par le Service hydrographique du Canada (SHC) et il est disponible gratuitement sous licence. Ce service web fournit des prédictions, des observations et des prévisions aux stations de niveaux d'eau à travers le Canada. D'autres informations sont également diffusées, telles que les plages de données disponibles, l'information sur les repères, les conversions de systèmes de référence altimétriques et les hauteurs de référence de niveaux d'eau. En fonction de la disponibilité, d'autre séries temporelles pourraient être obtenues comme les prévisions de dégagement vertical dynamiques à certains ponts, la vitesse du courant, la direction du courant, la température de l'eau et la salinité de l'eau. Des images, des tables de marées et des statistiques peuvent être également obtenues en utilisant ce service Web.

Spécifications techniques

Le service Web d'IWLS est accessible via un REST-API qui utilise le format JavaScript JSON. Ce service web est accessible à l'adresse suivante : https://api.iwls-sine.azure.cloud-nuage.dfo-mpo.gc.ca/swagger-ui/index.html.

L'API d'IWLS est constituée de neuf points de terminaison qui sont les suivants:

  • station statistics (statistiques d’une station)
  • height types (types de hauteurs)
  • tide tables (tables des marées)
  • station metadata (métadonnées d’une station)
  • data (données)
  • stations (stations)
  • time series definitions (définitions des séries temporelles)
  • benchmarks (repères)
  • phenomena (phénomène)

Chaque point de terminaison a d'une à six commandes GET différentes associées.

Les utilisateurs doivent prêter attention au code de l'indicateur de contrôle qualité (qcFlagCode) associée à chacune des données. Les indicateurs utilisés à tous les niveaux de contrôle de la qualité s'inspirent des normes de l'UNESCO en matière de données océanographiques.

Valeur Indicateur Définition
1 Bon Test réussi de contrôle de qualité
2 Non évalué, non-disponible ou inconnu Utilisé pour les données dont les tests de contrôle de qualité n'ont pas été effectués ou l'information sur la qualité n'est pas disponible
3 Questionnable ou suspect Données dont les tests de contrôle de qualité non critiques ont échoué

Pour vous familiariser avec l'API d'IWLS, la documentation est disponible directement sur la page du service Web.

Informations supplémentaires

Les schémas de l'API d'IWLS sont disponibles à l'adresse suivante : Swagger UI. Vous pouvez également tester les différents points de terminaison à la même adresse.

Pour recevoir des informations et des avis de mise à jour de cette interface, veuillez-nous transmettre votre nom et courriel à l'adresse suivante : chsinfo@dfo-mpo.gc.ca

Accès et restrictions

En utilisant l'API IWLS, vous acceptez de vous conformer à l'accord de licence.

Service Web donnant accès aux prévisions interpolées de niveaux d'eau dans le fleuve Saint-Laurent (API SPINE)

Description

Les prévisions SPINE de niveaux d'eau dans le fleuve Saint-Laurent sont calculées avec les résultats provenant 1) du modèle hydrodynamique OHPS-SFLE d'ECCC pour les 2 premiers jours dans le futur et 2) des prédictions non stationnaires de niveaux d'eau calculées avec l'algorithme NS_Tide d'ECCC pour les 28 jours suivants. Le modèle OHPS-SLFE utilise en amont les prévisions de débit du fleuve Saint-Laurent et de ses tributaires les plus importants le long de son cours. En aval, il utilise les niveaux d'eau de la prédiction de la marée astronomique auxquels s'ajoute la prévision d'onde de tempête pour les 2 premiers jours dans le futur. Ces prévisions combinées OHPS-SLFE+NS_TIDE sont ajustées selon les dernières observations enregistrées aux stations de mesures de niveaux d'eau adjacentes.

Spécifications techniques

Le service SPINE est accessible via un REST-API qui utilise le format JavaScript JSON. Ce service est accessible à l'adresse suivante: https://api-spine.azure.cloud-nuage.dfo-mpo.gc.ca/swagger-ui/index.html

L'API SPINE est constitué de trois points de terminaison de type GET. Il est à noter que seulement le premier point de terminaison nécessite la saisie de paramètres de la part de l'utilisateur.

Prévision interpolée de niveau d'eau

Au moyen d'une position géographique et d'un temps spécifiés par l'utilisateur, le modèle retourne une prévision de niveau d'eau interpolé dont le positionnement est rapporté au centre du chenal de navigation. Cette prévision interpolée de niveau d'eau est exprimée par rapport au zéro des cartes et elle est toujours accompagnée de l'âge du calcul en minutes et d'une valeur d'incertitude.

Pour utiliser la prévision, vous devrez saisir un couple latitude et longitude en degrés décimaux ainsi que la date et l'heure UTC au format ISO 8601. Il est important de souligner que seulement des coordonnées géographiques situées dans l'emprise du modèle (fleuve Saint-Laurent entre Montréal et Saint-Joseph-de-la-Rive) vont retourner une valeur de prévision de niveau d'eau.

L'utilisateur peut également demander plusieurs valeurs de prévisions interpolées au modèle via une seule requête en ajoutant séquentiellement toutes les latitudes, toutes les longitudes et tous les temps (date et heure UTC au format ISO 8601) désirés; le modèle retournera alors un nombre de réponses équivalent au nombre de trios latitude/longitude/temps saisis.

GET (/rest/v1/waterLevel)

Exemple d'une requête simple:

Exemple d'une requête multiple:

Si les coordonnées géographiques sont en dehors des limites géographiques du modèle, vous allez recevoir le message d'erreur suivant : "status": "DISTANCE_OUT_OF_RANGE".

Si la date demandée est en dehors des limites temporelles du modèle, vous allez recevoir le message d'erreur suivant : "status": "DATE_OUT_OF_RANGE".

Limites géographiques du modèle

Le deuxième point de terminaison vous permet de récupérer les limites géographiques (spatiales) pour lesquelles les prévisions de niveaux d'eau sont disponibles.

GET (/rest/v1/boundarySpatial)

Exemple:

Limites temporelles du modèle

Le troisième point de terminaison permet d'obtenir les limites temporelles (dates et heures) pour lesquelles les prévisions de niveaux d'eau sont disponibles.

Get (/rest/v1/boundaryDate)

Exemple :

Informations supplémentaires

Les schémas de l'API SPINE sont disponibles à l'adresse suivante : Swagger UI. Vous pouvez également tester les différents points de terminaison à la même adresse.

Pour recevoir des informations et des avis de mise à jour de cette interface, veuillez nous transmettre votre nom et courriel à l'adresse suivante : chsinfo@dfo-mpo.gc.ca.

Accès et restrictions

En utilisant l'API SPINE, vous acceptez de vous conformer à l'accord de licence.

Date de modification :