Aller au contenu principal
Top

Créer des identifiants API pour votre compte sandbox

SoldoPlans_Enterprise_202407_R_EN.svg

Votre compte sandbox est l'endroit idéal pour expérimenter, construire et tester vos intégrations en utilisant l'API Soldo Business sans aucun risque pour vos données de production. Pour commencer à utiliser l'API Soldo Business avec votre compte sandbox, vous devrez créer votre application afin de générer vos identifiants API.

Remarque : Le guide ci-dessous décrit comment générer les identifiants API pour votre compte sandbox. Le processus est identique pour les comptes de production. Vous pouvez trouver plus d'informations dans le Portail Business API : Configuration de l'API.
  1. Connectez-vous à votre compte sandbox.
  2. Dans le menu de gauche, sélectionnez Intégrations > API Business.
    WC_Sandbox_BAPI_IntegrationsSandboxMenuItemAnnotated_202501_EN.webp
  3. Sélectionnez Créer une application.
    WC_Sandbox_BAPI_CreateApplicationAnnotated_202501_EN.webp
  4. Entrez un nom pour votre application puis suivez les instructions pour générer et saisir une paire de clés valide.

    Remarque : La clé doit être une clé publique RSA 2048 bits valide au format PEM :
    -----BEGIN PUBLIC KEY-----
    {YOUR PUBLIC KEY HERE}
    -----END PUBLIC KEY-----

    WC_Sandbox_BAPI_CreateApplicationEnterDetailsAnnotated_202501_EN.webp

  5. Sélectionnez Suivant.
    WC_Sandbox_BAPI_CreateApplicationNextAnnotated_202501_EN.webp
  6. Ensuite, décidez à quelles informations votre application pourra accéder en sélectionnant ou désélectionnant les cases à cocher puis sélectionnez Continuer.
    WC_Sandbox_BAPI_CreateApplicationContinueAnnotated_202501_EN.webp
  7. Vérifiez vos informations puis faites défiler jusqu'en bas de l'écran pour reconnaître les termes et conditions.

    Remarque : Assurez-vous d'avoir lu les termes et conditions avant de les reconnaître. Vous pouvez le faire en suivant le lien fourni en bas de l'écran.

    WC_Sandbox_BAPI_TermsAndConditionsNotAcceptedLinkAnnotated_202501_EN.webp

  8. Sélectionnez Créer une application.
    WC_Sandbox_BAPI_TermsAccesptedCreateApplicationAnnotated_202501_EN (1).webp
Vos identifiants ne seront affichés qu'une seule fois. Traitez-les comme un mot de passe et conservez-les en sécurité. Ne les partagez qu'avec des personnes de confiance via un canal sécurisé.

WC_Sandbox_BAPI_CredentialsGenerated_202501_EN.webp

Votre compte sandbox est l'endroit idéal pour expérimenter, construire et tester vos intégrations en utilisant l'API Soldo Business sans aucun risque pour vos données de production. Pour commencer à utiliser l'API Soldo Business avec votre compte sandbox, vous devrez créer votre application afin de générer vos identifiants API.

Remarque : Le guide ci-dessous décrit comment générer les identifiants API pour votre compte sandbox. Le processus est identique pour les comptes de production. Vous pouvez trouver plus d'informations dans le Portail Business API : Configuration de l'API.
  1. Connectez-vous à votre compte sandbox.
  2. Dans le menu de navigation principal, allez à Intégrations > API Business.
  3. Sélectionnez Créer une nouvelle application.
    WC_BusinessAPI_MainNoApplication_CreateAnnotated_202512_Surface_EN.png
  4. Entrez un nom pour votre application.
Astuce : Cela doit refléter l'intégration ou l'outil auquel elle est liée.
  1. Entrez une clé publique. Vous devrez générer une paire de clés RSA 2048 bits valide au format PEM.

Qu'est-ce qu'une paire de clés ?

  • Clé publique : Partagée avec Soldo. Considérez-la comme un nom d'utilisateur — elle identifie votre application.
  • Clé privée : Gardée secrète. Elle est utilisée pour signer en toute sécurité vos requêtes API.

Vous pouvez trouver des instructions pour créer une paire de clés en utilisant openssl lors du processus de configuration.

  1. Sélectionnez Suivant.

WC_BusinessAPI_CreateAnnotated_202512_Surface_EN.png

  1. Sélectionnez les scopes dont votre application a besoin puis cliquez sur Continuer. Vous pouvez les modifier plus tard si nécessaire.
Astuce : Les scopes définissent les parties de votre compte Soldo auxquelles l'application peut accéder. Vous pouvez choisir de donner un accès en lecture seule ou complet pour chaque zone.

WC_BusinessAPI_ScopesSelectAnnotated_202512_Surface_EN.png

  1. Vérifiez vos paramètres et reconnaissez les termes et conditions.
    WC_BusinessAPI_TermsAnnotated_202512_Surface_EN.png
  2. Sélectionnez Créer une application
    WC_BusinessAPI_TermsAgreeAnnotated_202512_Surface_EN.png

Une fois créée, vos identifiants seront affichés dans une fenêtre popup :

  • ID client – identifie votre application
  • Secret client – utilisé pour l'authentification standard
  • Jeton d'empreinte digitale – utilisé pour l'authentification avancée ou le téléchargement de pièces jointes
Important : Ces identifiants ne sont affichés qu'une seule fois. Assurez-vous de les copier et de les conserver en sécurité avant de fermer la popup.

WC_BusinessAPI_CredentialsAnnotated_202512_Surface_EN.png

0 les gens ont voté. Sum of votes: 0