Base URL & Environnements

Guide complet sur l'utilisation des URL de base pour les requêtes API B-MO selon l'environnement sélectionné (PAP, TEST, LIVE).

Base URLs et Environnements

Les requêtes API pour les services B-MO peuvent être exécutées sur trois (3) environnements distincts :

PAP (Pré-production / Apprentissage) — Par défaut
```
https://svc.pap.bestcash.me/external
```
TEST (Sandbox / Test)
```
https://svc.test.bestcash.me/external
```
LIVE (Production) — (Nom technique : bmo)
```
https://svc.bmo.bestcash.me/external
```

Pour construire vos requêtes API, ajoutez le chemin spécifique de l'endpoint à l'URL de base correspondant à votre environnement d'exécution.

Données d'Entrée (Input)

Paramètres d'URL (Query parameters) : Les données de requête peuvent être transmises directement dans l'URL.
Corps JSON (JSON Body) : Pour les requêtes POST, PUT ou PATCH, les données doivent être fournies dans un objet JSON structuré.

Données de Sortie (Output)

Toutes les réponses renvoyées par les serveurs B-MO utilisent le format standard JSON (application/json).

Exemple de Requête GET

Voici un exemple de requête GET ciblant l'environnement PAP (par défaut) :

import axios from 'axios';

const apiKey = 'votre-cle-api';
const apiSecret = 'votre-secret-api';

axios.get('https://svc.pap.bestcash.me/external/v1/resource', {
  headers: {
    'X-Auth-ApiKey': apiKey,
    'X-Auth-ApiSecret': apiSecret
  },
  params: {
    // parametres ici
  }
})
.then(response => {
  console.log('Données de réponse :', response.data);
})
.catch(error => {
  console.error('Une erreur est survenue :', error.message);
});

Exemple de Requête POST

Voici un exemple de requête POST d'exécution d'opération :

import axios from 'axios';

const apiKey = 'votre-cle-api';
const apiSecret = 'votre-secret-api';

const requestData = {
  // payload JSON
};

axios.post('https://svc.pap.bestcash.me/external/v1/resource', requestData, {
  headers: {
    'X-Auth-ApiKey': apiKey,
    'X-Auth-ApiSecret': apiSecret,
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log('Données de réponse :', response.data);
})
.catch(error => {
  console.error('Une erreur est survenue :', error.message);
});

Synthèse des Environnements

Environnement par défaut : PAP (https://svc.pap.bestcash.me/external).
Environnement de test : TEST (https://svc.test.bestcash.me/external).
Environnement de production : LIVE / bmo (https://svc.bmo.bestcash.me/external).
Console de test (Playground) : Permet de basculer instantanément d'un environnement à un autre via le menu déroulant en haut de chaque console interactive.

Présentation