My App
Fournisseurs de services

Intégrer une nouvelle entreprise (API Fournisseur de services)

Intègre une nouvelle entreprise marchande au nom d'un fournisseur de services. Ce point de terminaison crée un nouvel utilisateur, une nouvelle entreprise et établit la relation de fournisseur de services. **Cas d'usage :** - Les fournisseurs de services (comme Payme) peuvent intégrer des marchands via leur propre plateforme - Automatise le processus d'enregistrement des entreprises - Établit automatiquement la relation de fournisseur de services **Ce que fait ce point de terminaison :** 1. Crée un nouveau compte utilisateur (si le numéro de téléphone n'existe pas) 2. Crée une nouvelle entreprise avec les informations fournies 3. Configure la configuration de l'entreprise (active l'accès API) 4. Crée un membre d'entreprise de fournisseur de services liant le fournisseur de services au marchand 5. Définit le code de parrainage si fourni **Notes importantes :** - L'entreprise authentifiée doit être un fournisseur de services (vérifié via middleware) - Le numéro de téléphone doit être unique - si un utilisateur avec ce téléphone existe déjà, une erreur est retournée - L'entreprise de fournisseur de services est automatiquement liée à l'entreprise marchande - L'accès API est automatiquement activé pour la nouvelle entreprise marchande **Authentification :** Nécessite les en-têtes de clé API. L'entreprise authentifiée doit être un fournisseur de services.

POST
/partner_api/service_providers/business_onboarding

Intègre une nouvelle entreprise marchande au nom d'un fournisseur de services. Ce point de terminaison crée un nouvel utilisateur, une nouvelle entreprise et établit la relation de fournisseur de services.

Cas d'usage :

  • Les fournisseurs de services (comme Payme) peuvent intégrer des marchands via leur propre plateforme
  • Automatise le processus d'enregistrement des entreprises
  • Établit automatiquement la relation de fournisseur de services

Ce que fait ce point de terminaison :

  1. Crée un nouveau compte utilisateur (si le numéro de téléphone n'existe pas)
  2. Crée une nouvelle entreprise avec les informations fournies
  3. Configure la configuration de l'entreprise (active l'accès API)
  4. Crée un membre d'entreprise de fournisseur de services liant le fournisseur de services au marchand
  5. Définit le code de parrainage si fourni

Notes importantes :

  • L'entreprise authentifiée doit être un fournisseur de services (vérifié via middleware)
  • Le numéro de téléphone doit être unique - si un utilisateur avec ce téléphone existe déjà, une erreur est retournée
  • L'entreprise de fournisseur de services est automatiquement liée à l'entreprise marchande
  • L'accès API est automatiquement activé pour la nouvelle entreprise marchande

Authentification : Nécessite les en-têtes de clé API. L'entreprise authentifiée doit être un fournisseur de services.

Authorization

X-API-KEY<token>

Clé API pour les requêtes de l'API Partenaire

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/partner_api/service_providers/business_onboarding" \  -H "Content-Type: application/json" \  -d '{    "owner": {      "phone": "+22507012345",      "firstName": "Jean",      "lastName": "Dupont",      "sex": "M"    },    "business": {      "name": "Magasin de Jean",      "category": "retail",      "categoryActivity": "home_appliances",      "city": "abidjan",      "municipality": "cocody",      "estimatedRevenueLow": 2400000,      "estimatedRevenueHigh": 5000000    }  }'
{
  "business": {
    "id": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
    "name": "Magasin de Jean",
    "reference": "BIZ-2024-001"
  },
  "serviceProviderMemberId": "29f81706-03a6-492f-92ee-5f0b2e9b18e7"
}
{
  "id": "unauthorized",
  "message": "Unauthorized",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "id": "business_not_service_provider",
  "message": "L'entreprise n'est pas un fournisseur de services",
  "extras": "L'entreprise authentifiée doit être un fournisseur de services pour accéder à ce point de terminaison"
}
{
  "id": "phone_already_in_use",
  "message": "Numéro de téléphone déjà utilisé",
  "extras": "Ce numéro de téléphone est déjà associé à un utilisateur existant"
}
{
  "id": "validation_error",
  "message": "Échec de la validation",
  "extras": {
    "errors": [
      {
        "field": "paymentDetails.data.paymentMethod",
        "rule": "in",
        "message": "The paymentDetails.data.paymentMethod must be one of the following: orange, wave, mtn, moov, djamo"
      },
      {
        "field": "paymentDetails.data.deviceId",
        "rule": "required",
        "message": "The paymentDetails.data.deviceId field is required when paymentDetails.type is soundbox"
      }
    ]
  }
}
{
  "id": "internal_error",
  "message": "Une erreur inattendue s'est produite",
  "extras": "Détails supplémentaires de l'erreur"
}

Créer une clé API pour une entreprise marchande (API Fournisseur de services) POST

Crée une clé API pour une entreprise marchande que le fournisseur de services a intégrée. Cela permet au marchand d'accéder à l'API Partenaire. **Prérequis :** - Le fournisseur de services doit avoir intégré l'entreprise marchande (via `/business_onboarding`) - Le fournisseur de services doit avoir la permission de créer des clés API pour le marchand **Cas d'usage :** - Générer des identifiants API pour les marchands après l'intégration - Permettre aux marchands d'intégrer avec l'API Partenaire de Jeko - Gérer l'accès API pour les entreprises marchandes **Notes importantes :** - L'entreprise authentifiée doit être un fournisseur de services - L'entreprise marchande doit exister et être liée au fournisseur de services - La clé API est retournée une seule fois lors de la création - stockez-la de manière sécurisée - La clé API est associée au membre de fournisseur de services qui l'a créée **Authentification :** Nécessite les en-têtes de clé API. L'entreprise authentifiée doit être un fournisseur de services.

Lister les activités commerciales (API Fournisseur de services) GET

Retourne la liste des catégories d'activités commerciales et leurs activités. Ce point de terminaison est équivalent à `/static/activities` mais filtre les catégories et activités désactivées. **Utilisez ce point de terminaison pour :** - Obtenir les catégories d'activités et activités valides pour l'enregistrement des entreprises - Afficher les options d'activité dans votre application - Valider les informations d'activité avant de créer des entreprises **Informations sur les activités :** - Seules les catégories et activités activées sont retournées - Les activités sont regroupées par catégorie - Prend en charge la sélection de langue via l'en-tête `Accept-Language` (par défaut en français) - Les catégories et activités sont triées par ordre alphabétique **Support multilingue :** - Envoyez `Accept-Language: en` pour l'anglais - Envoyez `Accept-Language: fr` pour le français (par défaut) **Authentification :** Nécessite les en-têtes de clé API. L'entreprise authentifiée doit être un fournisseur de services.