Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Cette page explique comment consulter, renouveler et révoquer les clés utilisées pour l’intégration technique de la solution Axepta Online BNP Paribas depuis le Portail Marchand.

La gestion des clés permet au commerçant ou à son intégrateur technique de sécuriser les échanges entre son système et la plateforme Axepta Online, notamment pour les appels API REST, les notifications serveur à serveur et, selon le mode d’intégration, les échanges utilisant les clés HMAC ou le mot de passe de cryptage.

Le renouvellement régulier des clés est recommandé pour des raisons de sécurité. Une rotation maîtrisée permet de remplacer les anciennes clés sans interruption de service.


Vue d’ensemble de l'onglet "Gestion des clés"

Accès à la page de gestion des clés

Depuis le Portail Marchand Axepta Online, accédez à la section Gestion des clés. La page affiche les informations suivantes :

  • le commerçant sélectionné ;,
  • les données d’accès disponibles ;,
  • les clés principales et secondaires ;,
  • les actions possibles sur chaque clé ;,
  • l’historique des dernières activités.

Remarque : selon votre profil utilisateur, la section de gestion des clés peut ne pas être visible.

Info
titleSélection du commerçant

En haut à droite de l’écran, le champ Commerçant permet de sélectionner le compte marchand concerné (dans le cas d’une gestion multi-comptes (MIDs)).

Avant toute opération, vérifiez que le bon commerçant est sélectionné.
Les clés affichées et les actions réalisées s’appliquent uniquement au commerçant sélectionné.

Données d’accès disponibles

La section Données d’accès contient les éléments techniques nécessaires à l’intégration.

Selon la configuration du compte, les éléments suivants peuvent être affichés :

Élément

Description

Usage principal

Mot de passe de cryptage

Mot de passe utilisé dans certains modes d’intégration historiques ou spécifiques

Chiffrement ou sécurisation de certains échanges

Clé HMAC principale

Clé HMAC active principale

Signature ou vérification de messages

Clé API REST principale

Clé principale utilisée pour les appels API REST

Appels API REST en production ou en test

Clé HMAC secondaire

Clé HMAC secondaire

Rotation de clé ou double run

Clé API REST secondaire

Clé secondaire utilisée pour les appels API REST

Rotation de clé ou double run

Les valeurs des clés sont masquées par défaut. Une icône d’affichage permet de visualiser temporairement une clé si votre profil y est autorisé. Une icône de copie est également disponible pour copier la valeur dans le presse-papiers.

  • Display iconImage Removed: temporarily reveals the hidden value of the key.
  • Copy iconImage Removed: copies the key to the clipboard for immediate use.
  • Action buttonImage Removed: action menu on the keys.

Available actions

Each key line includes an action menu available from the icon on the right side of the relevant field.

  • Icône d’affichageImage Added : permet de révéler temporairement la valeur masquée de la clé.
  • Icône de copieImage Added : permet de copier la clé dans le presse-papier pour une utilisation rapide.
  • Bouton de rafraîchissementImage Added : Menu des actions sur les CLés.

Actions disponibles sur les clés

Chaque ligne de clé dispose d’un menu d’actions accessible via l’icône située à droite du champ concerné.

Les actions disponibles peuvent sont les suivantes Available actions may include :

Action

Description

EffectEffet

Create

Generates a key when the field is empty

The new key can be used immediately

Renew

Generates a new value for an existing key

The previous value is replaced

Créer

Génère une clé lorsque le champ est vide

La nouvelle clé devient utilisable immédiatement

Renouveler

Génère une nouvelle valeur pour une clé existante

L’ancienne valeur est remplacée

Révoquer

Désactive et supprime la clé

La clé ne peut plus être utilisée

Revoke

Disables and deletes the key

The key can no longer be used


Info
titleWarning

Key revocation is immediate. Once revoked, the key must no longer be considered usable by your system.

Renewing a primary REST API key

Use this procedure when you need to replace the primary REST API key.

Steps

  1. Log in to the Axepta Online Merchant Portal.
  2. Open the Key Management section.
  3. Make sure the correct Merchant is selected.
  4. In the Access data section, identify the Primary REST API key line.
  5. Click the action menu on the right side of the key.
  6. Select Renew primary REST API key.
  7. Confirm the action when a confirmation message is displayed.
  8. Display or copy the new key.
  9. Update your configuration.
  10. Test REST API calls with the new key.
  11. Check that the expected transactions or technical operations work correctly.

 Zero-downtime rotation with secondary keys

For REST API integrations, Axepta Online may allow two sets of keys to be used in parallel : a primary key and a secondary key.

This feature is especially useful for rotating keys without service interruption.

Principle

The primary key remains used by the existing system while the secondary key is created or renewed.
The integrator then updates the application to use the new secondary key.
Once the new key has been validated, the old key can be revoked or renewed according to the defined strategy.

Recommended procedure

  1. Check which key is currently used by your system.
  2. Create or renew the secondary key.
  3. Configure your system to use this new key.
  4. Deploy the configuration.
  5. Perform technical tests:
    • simple REST API call;
    • transaction creation or retrieval;
    • notification or webhook validation, if applicable;
    • application log review.
  6. Monitor transactions.
  7. Once the new key is confirmed as operational, revoke the old key that is no longer required.

This approach reduces the risk of interruption because the old key remains available during the switch-over phase.

Revoking a REST API key

Revocation disables an existing key. It should only be used when you are sure the key is no longer used, or when compromise is suspected.

Steps

  1. Log in to the Axepta Online Merchant Portal.
  2. Open Key Management.
  3. Select the correct Merchant.
  4. Identify the key to revoke.
  5. Click the key action menu.
  6. Select Revoke.
  7. Confirm the operation.
  8. Check the activity history to confirm that the action was recorded.
  9. Make sure your system no longer use this key.

Important: a revoked key must no longer be used in your system. If the system continues to use a revoked key, the related API calls may fail.

Renewing an HMAC key

The HMAC key is used to sign or verify certain technical exchanges, especially when the integration relies on signature mechanisms.

Steps

  1. Open the Key Management section.
  2. Identify the Primary HMAC key or Secondary HMAC key.
  3. Open the action menu.
  4. Select the renewal action.
  5. Update your application configuration.
  6. Check that signatures generated or verified by your system remain valid.
  7. Review application logs and any authentication errors.

Latest activity history

The Latest activities section displays operations performed on keys.

It allows you to view:

  • the action or creation date;
  • the type of action performed;
  • the key concerned;
  • the operation details;
  • the user who performed the action;
  • the merchant concerned.

This section is useful for audit tracking, traceability and incident analysis.

Examples of visible actions:

  • key viewed;
  • key renewed;
  • key revoked;
  • encryption password viewed.

Export & Security

  • Keys cannot be exported as a file,
Attention

la révocation d’une clé est immédiate. Une fois révoquée, la clé ne doit plus être considérée comme utilisable.

Renouveler une clé API REST principale

Utilisez cette procédure lorsque vous souhaitez remplacer la clé API REST principale.

Étapes

  1. Connectez-vous au Portail Marchand Axepta Online,
  2. Accédez à la section Gestion des clés,
  3. Vérifiez que le bon Commerçant est sélectionné (dans le cas d’une gestion multi-comptes (MIDs)),
  4. Dans la section Données d’accès, identifiez la ligne Clé API REST principale,
  5. Cliquez sur le menu d’actions situé à droite de la clé,
  6. Sélectionnez Renouveler la clé API REST principale,
  7. Confirmez l’action sur la page de confirmation qui s'affiche,
  8. Affichez ou copiez la nouvelle clé,
  9. Mettez à jour votre configuration avec la nouvelle clé,
  10. Testez les appels API REST avec la nouvelle clé,
  11. Vérifiez que les transactions ou opérations techniques attendues fonctionnent correctement.

Rotation sans interruption avec les clés secondaires

La solution Axepta Online BNP Paribas permet l’utilisation de deux jeux de clés en parallèle : une clé principale et une clé secondaire.

Ce fonctionnement est particulièrement utile pour effectuer une rotation de clés sans interruption de service.

Principe

La clé principale reste utilisée par le système existant pendant que la clé secondaire est créée ou renouvelée.
Le commerçant met ensuite à jour sa configuration pour utiliser la nouvelle clé secondaire.
Une fois la nouvelle clé validée, l’ancienne clé peut être révoquée ou renouvelée selon la stratégie définie.

Procédure recommandée

  1. Vérifiez la clé actuellement utilisée dans votre configuration,
  2. Créez ou renouvelez la clé secondaire,
  3. Copiez la nouvelle clé secondaire dans un espace sécurisé,
  4. Configurez votre application pour utiliser cette nouvelle clé,
  5. Déployez la configuration,
  6. Effectuez des tests techniques :
    • appel API REST simple,
    • création ou consultation d’une transaction,
    • vérification des notifications ou webhooks si applicables.
  7. Lorsque la nouvelle clé est confirmée comme opérationnelle, révoquez l’ancienne clé devenue inutile.

Cette approche limite le risque d’interruption, car l’ancienne clé reste disponible pendant la phase de bascule.

Révoquer une clé API REST

La révocation désactive une clé existante. Elle doit être utilisée uniquement lorsque vous êtes certain que la clé n’est plus utilisée, ou lorsqu’une compromission est suspectée.

Étapes

  1. Connectez-vous au Portail Marchand Axepta Online,
  2. Accédez à Gestion des clés,
  3. Sélectionnez le bon Commerçant,
  4. Identifiez la clé à révoquer,
  5. Cliquez sur le menu d’actions de la clé,
  6. Sélectionnez Révoquer,
  7. Confirmez l’opération sur la page de confirmation qui s'affiche,
  8. Vérifiez dans l’historique que l’action a bien été enregistrée,
  9. Contrôlez que vos applications n’utilisent plus cette clé.

Important : une clé révoquée ne doit plus être utilisée dans vos applications. Si l’application continue d’utiliser une clé révoquée, les appels API se concluront par des échecs.

Renouveler une clé HMAC

La clé HMAC est utilisée pour signer ou vérifier certains échanges techniques, notamment lorsque l’intégration repose sur des mécanismes de signature.

Étapes

  1. Accédez à la section Gestion des clés,
  2. Identifiez la clé HMAC principale ou HMAC secondaire,
  3. Ouvrez le menu d’actions,
  4. Sélectionnez l’action de renouvellement,
  5. Copiez la nouvelle valeur dans un espace sécurisé,
  6. Mettez à jour la configuration de votre application,
  7. Vérifiez que les signatures générées ou vérifiées par votre système restent valides.

Historique des dernières activités

La section Dernières activités affiche les opérations réalisées sur les clés.

Elle permet notamment de consulter :

  • la date de création ou d’action,
  • le type d’action réalisée,
  • la clé concernée,
  • le détail de l’opération,
  • l’utilisateur ayant réalisé l’action,
  • le commerçant concerné.

Cette section est utile pour le suivi d’audit, la traçabilité et l’analyse en cas d’incident.

Exemples d’actions visibles :

  • consultation d’une clé,
  • renouvellement d’une clé,
  • révocation d’une clé,
  • consultation du mot de passe de cryptage.

Export et sécurité

  • Les clés ne sont pas exportables en fichier,
  • Pour des raisons de sécurité, elles sont affichées de manière masquée par défautFor security reasons, keys are hidden by default.