V1
Powered by

# Inscription

Toutes les opérations liées à la création et la validation d'un compte.

# Création d'un compte

Endpoint

POST api/v1/auth/register

# Body

Paramètre Type Requis Description
email string Non Adresse email de l'utilisateur
phone string Non Numéro de téléphone de l'utilisateur
password string Oui Mot de passe du compte
password_confirmation string Oui Confirmation du mot de passe

⚠️ NB : L'utilisateur peut s'inscrire avec l'adresse e-amil ou le numéro de téléphone.

# Exemple de requête. 

{
  "email": "user@example.com",
  "phone": "+22370000000",
  "password": "password123",
  "password_confirmation": "password123"
}

# Réponse

Si l'inscription est reussi, un code OTP est envoyé sur l'adresse e-email ou sur le numéro de téléphone pour la confirmation du compte.

{
    "status": 201,
    "message": "Un code de 6 chiffres a été envoyé par email."
}

# Confirmation du compte

Endpoint

POST /api/v1/auth/verify-account

# Body

Paramètre Type Requis Description
identifier string Oui Adresse e-mail ou numéro de téléphone du compte
otp string Oui Code OTP de confirmation

# Exemple de requête 

{

  "identifier": "john@example.com",
  "otp": "482193"
}

# Réponse 

{
    "status": 201,
    "message": "Compte confirmé avec succès"
}

# Renvoi du code de confirmation

Endpoint

POST /api/v1/auth/resend-confirmation

# Body

Paramètre Type Requis Description
identifier string Oui Adresse e-mail ou numéro de téléphone du compte

# Exemple de requête 

{
  "identifier": "john@example.com"
}

# Réponse 

{
    "status": 201,
    "message": "Un nouveau code de confirmation a été envoyé"
}