Documentation de TrueClient DZ

Endpoint

POST /api/request

Description

Cet endpoint permet de demander un code OTP (One-Time Password) pour l’authentification. L’utilisateur doit être authentifié et inclure un token dans l’en-tête pour accéder à cette fonctionnalité.

Limite de requête

• Limite de requête par minute : 30 req/minute

Authentification

• Méthode d’authentification : Token Bearer
• Token : Un token d’authentification généré speécialement pour vous, à obtenir depuis votre tableau de bord.

Paramètres Requis

• Header :
  • Authorization: Bearer<token> (remplacez <token> par le token d’authentification obtenu)
  • Accept : application/json
• Body (application/json) :
  • phone (string) : Le numéro de téléphone pour lequel l’OTP doit être demandé.
    Ce numéro doit être au format valide, commençant par 05, 06, ou 07, suivi de 8 chiffres (ex : 0612345678).
  • lang (string) : La langue dans laquel le SMS sera envoyer.
    Valeurs acceptées :
    • fr pour le français. Par défaut.
    • ar pour l’arabe.

Exemple de Requête

POST /api/request HTTP/1.1
        URL: trueclientdz.com
        Authorization: Bearer{your-auth-token}
        Accept: application/json

        {
        "phone": "055555555",
        "lang" : "ar"
        }
        

Exemple d’une réponse

Code : 200 OK

{
            "request_id": 1,
            "code": "SFS3NI",
            "phone": "055555555",
            "message": "TEXT IN ARABIC"
        }
        

Erreurs

Code : 401 Unauthorized
Condition : Token manquant ou invalide.
Exemple de réponse :

{
            "message": "Unauthenticated."
        }
        

Code : 403 Forbidden
Condition : Solde insufisant.
Exemple de réponse :

{
            "message": "Your solde is insufficient"
        }
        

Code : 403 Forbidden
Condition : Requête non autorisé.
Exemple de réponse :

{
            "message": "Invalid ability provided."
        }
        

Code : 422 Unprocessable Content
Condition : Paramètre phone manquant ou invalide.
Exemple de réponse :

{
            "message": "The phone field format is invalid.",
            "errors": {
                "phone": ["The phone field format is invalid."]
            }
        }
        

Code : 429 Too Many Requests
Condition : Dépassé la limite de nombre de requête par minute.
Exemple de réponse :

{
            "message": "Too Many Attempts."
        }
        

Code : 500 Internal Server Error
Condition : Une erreur est survenue lors du traitement de la demande.
Exemple de réponse :

{
            "error": "Internal Server Error",
            "message": "An unexpected error occurred. Please try again later."
        }