Documentation Développeur

Intégrez Ekonzo-Pay à vos applications et services.

Introduction

Bienvenue dans la documentation de l'API Ekonzo-Pay. Notre API RESTful vous permet d'intégrer facilement les fonctionnalités d'achat progressif dans vos propres applications. Que vous soyez un partenaire commercial souhaitant accepter des paiements ou un développeur créant une nouvelle expérience d'achat, notre API vous fournit les outils dont vous avez besoin.

L'URL de base de notre API est : https://api.ekonzo.com/v1

Authentification

Clé d'API

Toutes les requêtes vers l'API Ekonzo-Pay doivent être authentifiées à l'aide d'une clé d'API. Vous pouvez générer et gérer vos clés d'API depuis votre tableau de bord partenaire.

Incluez votre clé d'API dans l'en-tête Authorization de chaque requête.

Authorization: Bearer VOTRE_CLE_API

Exemples d'Intégration

Voici quelques exemples pour vous aider à démarrer rapidement avec l'API Ekonzo-Pay dans différents langages.

Exemple avec l'API Fetch (navigateur ou Node.js).

const apiKey = 'VOTRE_CLE_API';
const url = 'https://api.ekonzo.com/v1/payments';

const data = {
  goal_id: "goal_12345",
  user_id: "user_67890",
  amount: 25.50,
  currency: "USD"
};

fetch(url, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
.then(response => {
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return response.json();
})
.then(data => {
  console.log('Paiement créé:', data);
})
.catch(error => {
  console.error('Erreur lors de la création du paiement:', error);
});

Endpoints de l'API

Voici une description des principaux endpoints disponibles.

Paiements

POST/payments

Crée une nouvelle transaction de paiement pour un objectif d'achat.

{
  "goal_id": "goal_12345",
  "user_id": "user_67890",
  "amount": 25.50,
  "currency": "USD"
}

GET/payments/{paymentId}

Récupère les détails d'une transaction de paiement spécifique.

Objectifs

POST/goals

Crée un nouvel objectif d'achat pour un utilisateur.

{
  "user_id": "user_67890",
  "product_name": "Smartphone XYZ",
  "total_amount": 800.00,
  "target_date": "2024-12-31"
}

GET/goals/{goalId}

Récupère l'état d'avancement et les détails d'un objectif d'achat.

Utilisateurs

POST/users

Crée un nouvel utilisateur dans le système.

GET/users/{userId}

Récupère les informations d'un utilisateur.

Webhooks

Notifications en Temps Réel

Utilisez les webhooks pour recevoir des notifications en temps réel sur les événements importants, tels que la finalisation d'un paiement ou l'atteinte d'un objectif. Configurez l'URL de votre endpoint de webhook depuis votre tableau de bord partenaire.

Événements disponibles :

payment.succeeded
goal.completed
contribution.received