Débuter avec l’API de Moneris
L’API de Moneris utilise les principes de REST.
Votre serveur envoie une requête HTTP à vos endpoints (points de terminaison) avec un corps JSON en tant que données utiles; Moneris renvoie une réponse HTTP.
2. 1. Inscription à un compte du portail pour développeurs
Pour tout travail d'intégration et de développement avec les solutions de Moneris sous l'égide du nouveau Moneris APL, vous aurez besoin d'un compte pour le portail des développeurs de Moneris.
Veuillez considérer les scénarios suivants lors de la connexion ou de l'enregistrement d'un compte:
I am a Merchant with Moneris
1. A
Je suis un commerçant déjà inscrit auprès de Moneris
En tant que commerçant déjà inscrit auprès de Moneris, vous pouvez simplement utiliser les informations générales de votre compte Moneris (adresse électronique et mot de passe) pour vous connecter au nouveau portail des développeurs de Moneris.
Comme vous êtes un commerçant connu, votre accès à l'environnement Sandbox et Production est également automatiquement accordé et actif - Aucune étape supplémentaire n'est requise !
Vous pouvez passer à l'étape 2.
Je ne suis pas un commerçant chez Moneris / Je suis un développeur
2.B
Je suis un développeur travaillant sur une intégration pour le compte d'un ou plusieurs commerçants.
Comme vous n'êtes pas un commerçant de Moneris, vous n'aurez pas de compte préexistant pour le portail des développeurs de Moneris. Vous pouvez utiliser le lien ci-dessous pour créer un compte.
Veuillez considérer les éléments suivants :
En tant que tiers non inscrit comme commerçant auprès de Moneris, vous aurez un accès complet à l'environnement Sandbox mais pas à l'environnement de production.
Une fois le travail de développement terminé, vos clients devront générer leur propre ensemble d'informations d'identification à partir de leur propre compte du portail des développeurs Moneris.
S'il s'agit d'un commerçant inscrit auprès de Moneris, il peut suivre les étapes du point 1.A.
S'il ne s'agit pas d'un commerçant inscrit auprès de Moneris, il peut suivre les étapes du point 2. A.
2. A
Je suis un commerçant intéressé à m'inscrire auprès de Moneris, mais je travaillerai d'abord sur une intégration.
Comme vous n'êtes pas encore connu de Moneris, vous n'aurez pas de compte existant pour le portail des développeurs de Moneris. Vous pouvez utiliser le lien ci-dessous pour créer un compte.
Veuillez considérer les éléments suivants :
Lorsque cela est possible, utilisez la même adresse électronique pour la création de compte dans le portail des développeurs que celle que vous comptez utiliser pour votre compte marchand Moneris.
Seuls les comptes du portail de développeur créés avec la même adresse électronique que celle utilisée pour le compte marchand Moneris ont accès aux environnements de production.
Si une adresse e-mail différente doit être utilisée, vous devrez créer un compte de portail de développeur distinct pour accéder à l'environnement de production.
2. Accès à votre compte du portail pour développeurs
Passez directement à la page Accès et identifiants en cliquant sur le bouton ci-dessous.
Vous aurez besoin de vous connecter au portail pour développeurs de Moneris afin de générer votre ID de client et votre secret de client pour l’authentification OAuth :
Connectez-vous en utilisant les identifiants du portail pour développeurs.
À partir du menu de navigation du compte au haut de l’écran, sélectionnez « Accès et identifiants » ou cliquez sur le bouton à droite.
Cliquez sur Nouveau client.
Copiez l’ID de client et le secret du client pour le client que vous avez créé.
3. Obtention d’un jeton d’accès (Access token)
Maintenant que vous avez des identifiants pour l’OAuth, vous pouvez effectuer votre premier appel à l’API de Moneris pour obtenir un jeton d’accès. Ce jeton d’accès est utilisé dans l’en-tête HTTP de tous les autres appels à l’API REST pour authentifier votre serveur auprès de Moneris.
Exemple de requête de jeton d’accès :
POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host:api.sb.moneris.io
grant_type=client_credentials&client_id=[clientId]&client_secret=[clientSecret]&scope=payment.write
REMARQUE : Remplacez [ClientID] et [ClientSecret] par les identifiants que vous avez obtenus plus tôt de votre profil du portail pour développeurs de Moneris.
Exemple de réponse de jeton d’accès Get:
{
"token_type": "Bearer",
"expires_in": "3600",
"access_token": "[accessToken]"
}
Obtenez la valeur du champ « access_token » pour l'utiliser dans l'en-tête (header)
Autres méthodes d’authentification
Au lieu d’OAuth, vous pouvez utiliser des clés API pour authentifier le traitement des transactions. Moneris ne recommande pas cette pratique, mais si votre intégration le requiert, consultez la page « Accès et identifiants » pour obtenir des renseignements sur l’obtention de votre clé API et son utilisation dans l’en-tête HTTP pour l’authentification auprès de l’API de Moneris.
4. Accès à l’environnement bac à sable de votre compte de commerçant
Passez directement à la page Accès et identifiants en cliquant sur le bouton ci-dessous.
Vous aurez besoin d’un compte du portail pour développeurs de Moneris afin de générer votre ID de client et votre secret de client pour l’authentification OAuth :
Connectez-vous en utilisant les identifiants du portail pour développeurs.
À partir du menu de navigation du compte au haut de l’écran, sélectionnez « Accès et identifiants » ou cliquez sur le bouton à droite.
Localisez et copier l'ID test de compte de commerçant.
5. Premier appel à l’API
Achat de base
Effectuez un paiement simple entre un commerçant et un client. Ce paiement autorise et récupère les fonds en un seul appel à l’API pour les déposer dans le compte bancaire du commerçant.
Maintenant que vous avez votre jeton d’accès de support et un ID de commerçant test, vous êtes prêt à effectuer votre premier appel à l’API auprès de l’API de Moneris. Pour l’instant, suivez le processus de l’achat de base pour tester l’endpoint (point de terminaison) POST de création du paiement. Notre Référence API peut vous aider avec les définitions de chaque champ.
6. Choix en matière de gestion des renseignements de la carte
Apprenez-en plus sur la transformation en jetons hébergée en cliquant sur le bouton.
La plus importante partie de la conception de votre solution est sa gestion des données de la carte avant l’authentification ou les paiements autorisés. Les normes de l’industrie des cartes de paiement (PCI) sur les données de sécurité comprennent des mesures strictes concernant la protection des données des titulaires de carte. La conformité aux normes PCI DSS est obligatoire si vous décidez de gérer des données de carte directement sur votre site Web, mais Moneris offre d’autres solutions pour éviter que votre site Web traite directement les données de la carte. Vous pouvez faire ce qui suit :
Mettre en place un cadre hébergé par Moneris sur votre site Web de commerçant qui collecte les données de la carte du client et renvoie un jeton temporaire qui représente la carte de votre transaction. Ce jeton protège les données de la carte contre le vol et vous libère de la conformité aux normes PCI DSS. Consultez le guide du processus de transformation en jetons hébergée pour obtenir des renseignements.
Vous pouvez recueillir des données sur votre site Web de commerçant. La conformité aux exigences de sécurité des données de la PCI est requise.
Consultez la page https://www.moneris.com/fr-ca/soutien/conformité-et-sécurité/securite-des-donnees-pci pour obtenir des conseils de Moneris sur les exigences de la PCI.
7. Scénarios de test
Gestion des réponses
Apprenez-en plus sur la gestion des réponses de l’API de Moneris, la confirmation de l’état de la requête et la création d’une logique au sein de votre solution.
Simulateur de valeur des cents
Un système de simulateur dans lequel la valeur des cents de la transaction détermine le code de réponse dans l’environnement de tests.
8. Lancement de la production
Consulter la page Accès et identifiants
Veuillez noter :
Afin d'effectuer des appels API en production, votre portail de développeur unifié doit être lié à un compte de portail Moneris (et/ou Merchant Direct) reconnu.
Pour ce faire, vous devez créer un compte sur le portail de développeur unifié avec la même adresse électronique que votre compte sur le portail Moneris (et/ou Merchant Direct). Ensuite, sur la page Accès et informations d'identification, vous pouvez appuyer sur le bouton Production et générer les informations d'identification de production pour votre identifiant de marchand.
Votre entreprise peut avoir besoin d’autres fonctions facultatives. L’API de Moneris fournit d’autres endpoints (points de terminaison) pour l’intégration du traitement des paiements pour améliorer votre entreprise, comme le stockage des données de carte auprès de Moneris pour favoriser l’expérience de magasinage de la clientèle fidèle.
Consultez les fonctionnalités additionnelles pour connaître les fonctionnalités qui répondraient au besoin de votre entreprise. Consultez les processus d’implémentation et la Référence API pour leurs endpoints (points de terminaison) afin d’aider à les ajouter à votre solution.
URL de production : https://api.moneris.io
Renseignements supplémentaires
Définitions de l’API
Consultez les endpoints (points de terminaison), les formats des demandes et des réponses, ainsi que les modes d’authentification de ce scénario.
.svg)