Gestion des Plateformes

Vue d'ensemble

Cette section présente l'API de gestion des plateformes marchandes, qui permet aux utilisateurs de créer et administrer leurs espaces commerciaux virtuels. Chaque plateforme représente un point de vente numérique avec ses propres paramètres, branding et gestion financière.

Fonctionnalités couvertes

Notre API de plateformes offre une suite complète d'outils de gestion :

Administration des plateformes

Création de nouvelles plateformes avec paramètres personnalisés
Consultation de toutes les plateformes avec pagination avancée
Récupération des détails spécifiques par identifiant unique (slug)
Gestion des métadonnées et descriptions personnalisées

Gestion financière

Consultation des soldes en temps réel (solde actuel et revenus)
Historique des mises à jour de balance
Tracking des transactions entrantes et sortantes
Support multidevise selon la configuration

Branding et identité

Upload et gestion des logos/images de plateforme
Téléchargement des assets visuels par slug
Personnalisation de l'URL et description de la plateforme
Gestion des références uniques pour identification

Sécurité et intégration

Génération et gestion des clés API pour intégrations tierces
Contrôle d'accès basé sur les slugs de plateforme
Statuts d'activation pour contrôler la disponibilité

Architecture et organisation

L'API suit une logique de gestion centralisée où :

Chaque plateforme dispose d'un slug unique pour identification
Les balances sont mises à jour en temps réel lors des transactions
Les images sont gérées séparément avec leurs propres slugs
Les clés API permettent l'intégration avec des systèmes externes

Cette structure modulaire facilite l'évolutivité et la maintenance des plateformes commerciales tout en garantissant la sécurité des données financières.

| Action | Endpoint | |---|---| | POST | /api/v1/platform | | GET | /api/v1/platforms | | GET | /api/v1/platform/by-slug/{slug} | | GET | /api/v1/platform/balance/by-slug/{slug} | | GET | /api/v1/platform/apikey/by-slug/{slug} | | POST | /api/v1/platform/image/by-slug/{slug} | | GET | /api/v1/platform/image/by-slug/{fileSlug} |

Création d'une plateforme

Endpoint: POST /api/v1/platform

Crée une nouvelle plateforme.

Corps de la requête

{
  "name": "MyPlatform",
  "url": "https://myplatform.com",
  "description": "An online service",
  "metaData": "optional metadata"
}

Réponse

{
  "message": "success",
  "body": {
    "slug": "OEIEJNFJ-dkdidduh-ididoidj",
    "name": "buy more",
    "image": "live",
    "reference": "0955438",
    "url": "exempl@ingenovatech.com",
    "description": "vendeur",
    "metaData": "string",
    "status": "ACTIVATED",
    "balance": {
      "currentBalance": 0,
      "incomeBalance": 0,
      "lastUpdatedDate": "2025-06-01T00:09:00.951Z"
    }
  }
}

Récupération de toutes les plateformes

Endpoint: GET /api/v1/platforms

Récupère toutes les plateformes accessibles par l'utilisateur (paginé).

Paramètres de la requête

page : nombre
size : nombre
sort : field,asc|desc

Réponse

{
  "message": "Success",
  "body": {
    "totalPages": 0,
    "totalElements": 0,
    "pageable": {
      "paged": true,
      "pageNumber": 0,
      "pageSize": 0,
      "offset": 0,
      "sort": {
        "sorted": true,
        "empty": true,
        "unsorted": true
      },
      "unpaged": true
    },
    "size": 0,
    "content": [
      {
        "slug": "OEIEJNFJ-dkdidduh-ididoidj",
        "name": "buy more",
        "image": "string",
        "reference": "0955438",
        "url": "exempl@ingenovatech.com",
        "description": "string",
        "metaData": "string",
        "status": "ACTIVATED",
        "balance": {
          "currentBalance": 0,
          "incomeBalance": 0,
          "lastUpdatedDate": "2025-06-01T00:10:15.877Z"
        }
      }
    ],
    "number": 0,
    "sort": {
      "sorted": true,
      "empty": true,
      "unsorted": true
    },
    "numberOfElements": 0,
    "first": true,
    "last": true,
    "empty": true
  }
}

Obtention des details de la plateforme

Endpoint: GET /api/v1/platform/by-slug/{slug}

Obtient les détails de la plateforme par slug.

Paramètres de la requête

slug : slug de la plateforme

Réponse

{
  "message": "string",
  "body": {
    "slug": "string",
    "name": "string",
    "image": "string",
    "reference": "string",
    "url": "string",
    "description": "string",
    "metaData": "string",
    "status": "ACTIVATED",
    "balance": {
      "currentBalance": 0,
      "incomeBalance": 0,
      "lastUpdatedDate": "2025-06-01T00:11:37.272Z"
    }
  }
}

Récupération de la balance de la plateforme

Endpoint: GET /api/v1/platform/balance/by-slug/{slug}

Récupère la balance associée à la plateforme spécifiée.

Paramètres de la requête

slug : slug de la plateforme

Réponse

{
  "message": "succes message",
  "body": {
    "currentBalance": 0,
    "incomeBalance": 0,
    "lastUpdatedDate": "2025-06-01T00:14:16.299Z"
  }
}

Récupération de la clé API de la plateforme

Response: GET /api/v1/platform/apikey/by-slug/{slug}

Récupère la clé/le jeton API d'une plateforme.

Paramètres de la requête

slug : slug de la plateforme

Réponse

{
  "message": "succes message",
  "body": {}
}

Images de la plateforme

Endpoint: POST /api/v1/platform/image/by-slug/{slug}

Télécharge ou met à jour l'image/logo de la plateforme.

Paramètres de la requête

slug : slug de la plateforme

Réponse

{
  "file": "image.png"
}

Téléchargement d'une image par balise

Endpoint: GET /api/v1/platform/image/by-slug/{fileSlug}

Télécharge le logo ou le fichier image par balise.

Paramètres de la requête

fileSlugs : slug de l'image

Réponse

{
  "image.png"
}

Utilisez cette section pour intégrer et gérer les fonctionnalités liées à la plate-forme dans votre application.

Paiements

Transactions