Sélection de la langue

Recherche


Interface de programmation d’application ( IPA ) du taux de change

Télécharger le fichier .json (12,4 Ko)

Utilisation

L’IPA permet aux utilisateurs de rechercher des taux de change de devises étrangères. Les taux enregistrés indiquent le nombre de dollars canadiens nécessaires pour acheter une seule unité de la devise étrangère. Les nouveaux taux sont publiés par la Banque du Canada (BdC) chaque jour à 16 h 30. L'Agence des services frontaliers du Canada (ASFC) récupère ces mises à jour entre 16 h 30 et 17 h (HNE).

La BdC fournit les taux de 23 devises étrangères. Tous les autres taux sont maintenus par l'ASFC.

Les taux de change de la BdC sont mis à jour quotidiennement dans le système alors que les autres taux de changes sont mis à jour par l’ASFC à des intervalles déterminés . Les taux actualisés sont disponibles pour récupération  entre 19 h et 23 h 59 (HNE).

Si l’intervalle ci-haut mentionné est manqué, l’utilisateur peut encore récupérer les taux de change actifs en utilisant l’IPA des taux de change historiques.

S’il-vous-plaît noter que l’utilisation de l’IPA des taux de change historiques :

  1. Requiert des paramètres de date de début et date de fin.
  2. Si vous récupérez une grande quantité de données, utilisez les paramètres limites et de sauts.

Fréquence de mise à jour

Compte tenu que la BdC publie ses taux de change à chaque jour ouvrable, il est recommandé de récupérer quotidiennement les données relatives aux taux de change. Cette récupération doit avoir lieu après 19 h (HNE) pour assurer la récupération des dernières mises à jour.

Notes techniques

Le taux de change IPA utilise LoopBack 4, un cadre à source ouverte pour créer une IPA REST dynamique d’un bout à l’autre. Veuillez vous référer à l’AWS API Gateway pour plus de détails. Deux serveurs seront fournis, un pour le développement et les tests et l'autre pour les données de production réelles. Veuillez vous assurer qu'ils sont accessibles de façon appropriée pendant le cycle de vie du développement.

Codes d'erreur


Type: Data Validation
HTTP status code: 400 (Bad Request)
Description: The client sends some invalid data in the request, for example, missing or incorrect content in the payload or parameters. Could also represent a generic client error.

Type: Throttling
HTTP status code: 429 (Too Many Requests)
Description: The client is sending more than the allowed number of requests per unit time.

Type: Dependency Issues
HTTP status code: 502 (Bad Gateway)-504 (Gateway Timeout)
Description: A dependent service is throwing errors (502) or timing out (504).

Type: Unhandled Errors
HTTP status code: 500 (Internal Server Error)-503 (Service Unavailable)
Description: The service failed in an unexpected way (500), or is failing but is expected to recover (503).

Ces codes d'erreur sont destinés à des fins d'intégration de système à système et n'ont donc pas été traduits en français.

Chemin d’accès

GET /exchange-rates

(exchangeRateControllerExternal.find)

Trouve tous les taux de change qui correspondent au filtre (si aucun filtre n'est spécifié, tous les taux sont retournés)

Paramètres de requête

filter (optional)
Query Parameter

Type de retour

array[ExchangeRate]

Exemple de données

Content-Type: application/json
   "ForeignExchangeRates": [
        {
            "ExchangeRateId": 719352,
            "Rate": "0.1589",
            "ExchangeRateEffectiveTimestamp": "2021-11-03T00:00:00.000Z",
            "ExchangeRateExpiryTimestamp": "2021-11-03T23:59:59.000Z",
            "ExchangeRateSource": "BoC",
            "FromCurrency": {
                "Value": "HKD"
            },
            "FromCurrencyCSN": 87,
            "ToCurrency": {
                "Value": "CAD"
            },
            "ToCurrencyCSN": 36
        } ]

Produit

Cet appel API produit les types de média suivants selon Accept en-tête de demande; le type de média sera véhiculé par Content-Type en-tête de réponse.
  • application/json

Réponses

200

Tableau d'instances de modèle de taux de change

Modèles

Table des matières

ExchangeRate.Fields - ExchangeRate.Fields Up

ExchangeRateId
ExchangeRateSourceCSN
FromCurrency
FromCurrencyCSN
ToCurrency
ToCurrencyCSN
Rate
ValidStartDate
ValidEndDate

ExchangeRate.Filter - ExchangeRate.Filter Up

limit (optional)
example: 100
skip (optional)
ExchangeRateId
Number type: number maxLength: 20 minLength: 1 nullable: false example: CAD to USD
Description: Un identifiant unique pour tous les taux de change actifs et historiques
ExchangeRateSourceCSN
Number type: number minLength: 3 maxLength: 4 enum: - BOC - Banque du Canada (BdC) - CBSA - ASFC
Description: Un pointeur vers la source le taux de change (Principalement la Banque du Canada (BdC) et l'ASFC)
FromCurrency
String type: Char
Description: Un pointeur vers le code de devise à trois caractères, qui représente la devise du 'Taux'.
FromCurrencyCSN
Number type: Char
Description: Un pointeur vers le code de devise à trois caractères, qui représente la devise du 'Taux'.
ToCurrency
String type: Char
Description: Un pointeur vers le code de devise à trois caractères, qui représente la devise du 'Taux'.
ToCurrencyCSN
Number type: Char
Description: Un pointeur vers le code de la devise à trois caractères, qui représente la devise de la sortie lors de la division d’un montant d’argent (dans 'A partir de la devise') par le 'Taux'
Rate
String type: Char
Description: Le nombre d'unités 'A partir de la devise' pour acheter une seule unité 'À la devise'
ValidStartDate
Date type: string format: date-time
Description: La date à laquelle le taux de change est actif (inclusivement lié)
ValidEndDate
Date type: string format: date-time
Description: La date à laquelle le taux de change n'est plus actif (exclusivement lié)

GET /exchange-rates/ exchange-rates?startDate=2021-10-22&endDate=2021-10-23&limit=10&skip=2

(exchangeRateControllerExternal.find)

Trouve tous les taux de change qui correspondent au filtre (si aucun filtre n'est spécifié, tous les taux sont retournés)

Query Parameter

limit (optional)
example: 100
skip (optional)
startDate
Date type: string format: date-time
Description: La date à laquelle le taux de change est actif (inclusivement lié)
endDate
Date type: string format: date-time
Description: La date à laquelle le taux de change n'est plus actif (exclusivement lié)

Type de retour

array[ExchangeRate]

Exemple de données

Content-Type: application/json
  "ForeignExchangeRates": [
        
	{
            "ExchangeRateId": 718988,
            "Rate": "0",
            "ExchangeRateEffectiveTimestamp": "2021-10-22T00:00:00.000Z",
            "ExchangeRateExpiryTimestamp": "2021-10-22T23:59:59.000Z",
            "ExchangeRateSource": "CBSA",
            "FromCurrency": {
                "Value": "bpg"
            },
            "FromCurrencyCSN": 267,
            "ToCurrency": {
                "Value": "CAD"
            },
            "ToCurrencyCSN": 36
        },
        {
            "ExchangeRateId": 718990,
            "Rate": "0",
            "ExchangeRateEffectiveTimestamp": "2021-10-22T00:00:00.000Z",
            "ExchangeRateExpiryTimestamp": "2021-10-22T23:59:59.000Z",
            "ExchangeRateSource": "CBSA",
            "FromCurrency": {
                "Value": "mpg"
            },
            "FromCurrencyCSN": 266,
            "ToCurrency": {
                "Value": "CAD"

            },
            "ToCurrencyCSN": 36
        },
 ]

Produit

Cet appel API produit les types de média suivants selon Accept en-tête de demande; le type de média sera véhiculé par Content-Type en-tête de réponse.
  • application/json

Réponses

200

Tableau d'instances de modèle de taux de change

Modèles

Table des matières

ExchangeRate.Fields - ExchangeRate.Fields Up

ExchangeRateId
ExchangeRateSourceCSN
FromCurrency
FromCurrencyCSN
ToCurrency
ToCurrencyCSN
Rate
ValidStartDate
ValidEndDate

ExchangeRate.Filter - ExchangeRate.Filter Up

limit (optional)
example: 100
skip (optional)
ExchangeRateId
Number type: number maxLength: 20 minLength: 1 nullable: false example: CAD to USD
Description: Un identifiant unique pour tous les taux de change actifs et historiques
ExchangeRateSourceCSN
Number type: number minLength: 3 maxLength: 4 enum: - BOC - Banque du Canada (BdC) - CBSA - ASFC
Description: Un pointeur vers la source le taux de change (Principalement la Banque du Canada (BdC) et l'ASFC)
FromCurrency
String type: Char
Description: Un pointeur vers le code de devise à trois caractères, qui représente la devise du 'Taux'.
FromCurrencyCSN
Number type: Char
Description: Un pointeur vers le code de devise à trois caractères, qui représente la devise du 'Taux'.
ToCurrency
String type: Char
Description: Un pointeur vers le code de devise à trois caractères, qui représente la devise du 'Taux'.
ToCurrencyCSN
Number type: Char
Description: Un pointeur vers le code de la devise à trois caractères, qui représente la devise de la sortie lors de la division d’un montant d’argent (dans 'A partir de la devise') par le 'Taux'
Rate
String type: Char
Description: Le nombre d'unités 'A partir de la devise' pour acheter une seule unité 'À la devise'
ValidStartDate
Date type: string format: date-time
Description: La date à laquelle le taux de change est actif (inclusivement lié)
ValidEndDate
Date type: string format: date-time
Description: La date à laquelle le taux de change n'est plus actif (exclusivement lié)
Date de modification :