Valider la Clé API

curl --request GET \
  --url https://billapi.oneclickdz.com/v3/validate \
  --header 'X-Access-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://billapi.oneclickdz.com/v3/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billapi.oneclickdz.com/v3/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Access-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billapi.oneclickdz.com/v3/validate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Access-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billapi.oneclickdz.com/v3/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "account": {
      "id": "<string>",
      "status": "<string>",
      "currency": "<string>"
    },
    "key": {
      "type": "<string>"
    }
  },
  "meta": {
    "timestamp": "<string>"
  },
  "requestId": "<string>"
}

GET

validate

Valider la Clé API

curl --request GET \
  --url https://billapi.oneclickdz.com/v3/validate \
  --header 'X-Access-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://billapi.oneclickdz.com/v3/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billapi.oneclickdz.com/v3/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Access-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billapi.oneclickdz.com/v3/validate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Access-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billapi.oneclickdz.com/v3/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "account": {
      "id": "<string>",
      "status": "<string>",
      "currency": "<string>"
    },
    "key": {
      "type": "<string>"
    }
  },
  "meta": {
    "timestamp": "<string>"
  },
  "requestId": "<string>"
}

Vue d’ensemble

Vérifie votre clé API Bill Payment et vous renvoie qui vous êtes ainsi que l’environnement auquel la clé est rattachée. C’est le premier appel à effectuer dans une nouvelle intégration, et le moyen le plus sûr de prouver, avant de déplacer le moindre argent, que vous pointez bien vers le sandbox et non vers la production.

Chaque clé est rattachée à exactement un environnement — SANDBOX ou PRODUCTION. L’environnement est une propriété de la clé que nous vous délivrons. Ne le déduisez jamais du texte ni du préfixe de la clé ; lisez key.type depuis cet endpoint.

Bill Payment est hébergé sur https://billapi.oneclickdz.com, et non sur l’URL de base utilisée par le reste de la plateforme. L’en-tête est le même que celui que vous utilisez déjà : X-Access-Token.

Réponse

boolean

requis

true lorsque la clé a été vérifiée.

object

requis

Afficher properties

object

requis

Afficher properties

string

requis

L’identifiant de votre compte partenaire.

string

requis

ACTIVE pour une clé qui a passé la vérification.

string

requis

Toujours DZD.

object

requis

Afficher properties

string

requis

SANDBOX ou PRODUCTION. La seule indication fiable de l’environnement dans lequel cette clé agit.

object

requis

Afficher properties

string

requis

Heure de la réponse, ISO 8601 UTC.

string

requis

Identifiant de corrélation, également envoyé dans l’en-tête de réponse X-Request-Id.

Exemples

curl https://billapi.oneclickdz.com/v3/validate \
  -H "X-Access-Token: YOUR_API_KEY"

const response = await fetch("https://billapi.oneclickdz.com/v3/validate", {
  headers: { "X-Access-Token": process.env.ONECLICKDZ_API_KEY },
});

const body = await response.json();

if (!body.success) {
  throw new Error(`${body.error.code}: ${body.error.message}`);
}

console.log(`Account ${body.data.account.id} — ${body.data.key.type}`);

import os
import requests

response = requests.get(
    'https://billapi.oneclickdz.com/v3/validate',
    headers={'X-Access-Token': os.getenv('ONECLICKDZ_API_KEY')}
)

body = response.json()

if not body['success']:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")

print(f"Account {body['data']['account']['id']} — {body['data']['key']['type']}")

<?php
$ch = curl_init('https://billapi.oneclickdz.com/v3/validate');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-Access-Token: ' . getenv('ONECLICKDZ_API_KEY')
]);

$body = json_decode(curl_exec($ch), true);
curl_close($ch);

if (!$body['success']) {
    throw new Exception($body['error']['code'] . ': ' . $body['error']['message']);
}

echo "Account {$body['data']['account']['id']} — {$body['data']['key']['type']}";
?>

Réponse de succès

{
  "success": true,
  "data": {
    "account": {
      "id": "partner_7f21",
      "status": "ACTIVE",
      "currency": "DZD"
    },
    "key": {
      "type": "SANDBOX"
    }
  },
  "meta": {
    "timestamp": "2026-08-31T10:15:32.194Z"
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

Réponses d’erreur

401 — Token d'Accès Manquant

L’en-tête X-Access-Token n’a pas été envoyé.

{
  "success": false,
  "error": {
    "code": "MISSING_ACCESS_TOKEN",
    "message": "X-Access-Token header is required."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

Que faire : ajoutez l’en-tête. Bill Payment n’accepte la clé que dans cet en-tête — jamais dans une chaîne de requête ni dans un corps de requête.

401 — Token d'Accès Invalide

La clé a été rejetée.

{
  "success": false,
  "error": {
    "code": "INVALID_ACCESS_TOKEN",
    "message": "The provided access token is invalid."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

Que faire : cherchez une erreur de copier-coller, puis contactez le support. Réessayer avec la même clé ne changera pas la réponse.

503 — Authentification Indisponible

Nous n’avons pas pu vérifier votre clé à temps. Votre clé n’est pas en cause.

{
  "success": false,
  "error": {
    "code": "AUTH_UNAVAILABLE",
    "message": "Authentication is temporarily unavailable. Please retry shortly."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

Que faire : attendez le délai de l’en-tête Retry-After (5 secondes) puis réessayez. Ne présentez jamais cette erreur à votre client comme une erreur d’identifiants invalides, et ne désactivez jamais la clé pour cette raison.

503 — Service Indisponible

L’API Bill Payment est en maintenance planifiée.

{
  "success": false,
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "The service is temporarily unavailable. Please retry shortly."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

Que faire : respectez Retry-After et réessayez.

Confirmer votre environnement avant la mise en production

Exécutez cette vérification au démarrage, puis à nouveau dans votre pipeline de déploiement. Une seule ligne de sortie vous indique si la clé présente dans la configuration de cet environnement est bien celle que vous vouliez livrer.

async function assertEnvironment(expected) {
  const response = await fetch("https://billapi.oneclickdz.com/v3/validate", {
    headers: { "X-Access-Token": process.env.ONECLICKDZ_API_KEY },
  });

  const body = await response.json();

  if (!body.success) {
    throw new Error(`Key check failed: ${body.error.code}`);
  }

  if (body.data.key.type !== expected) {
    throw new Error(
      `Wrong key: expected ${expected}, got ${body.data.key.type}`,
    );
  }

  return body.data.account.id;
}

// In your sandbox deployment
await assertEnvironment("SANDBOX");

Une clé sandbox et une clé de production ont la même forme, mais pas le même effet. Une clé de production déplace de l’argent réel dès le premier paiement réussi. Vérifiez key.type avant d’activer le chemin de paiement.

Ce que cet endpoint ne retourne pas

Les clés Bill Payment n’ont ni portées, ni champ d’expiration, ni solde par clé : rien de tout cela n’apparaît ici. account, key.type, meta et requestId constituent l’intégralité de la réponse.

Bonnes pratiques

Appeler au Démarrage

Un seul appel au démarrage prouve que la clé fonctionne et nomme l’environnement, avant que le moindre trafic client n’atteigne le chemin de paiement.

Ne Jamais Journaliser la Clé

Journalisez plutôt account.id et key.type. La clé elle-même a sa place dans un coffre à secrets, jamais dans les journaux applicatifs.

Séparer les Deux Clés

Conservez les clés sandbox et production dans des espaces de configuration différents, afin qu’aucune ne soit accessible depuis l’autre environnement.

Traiter le 503 comme Transitoire

AUTH_UNAVAILABLE signifie que nous n’avons pas pu répondre à temps. Réessayez après Retry-After ; ne changez pas la clé.

Endpoints associés

Lister les Partenaires

Vérifiez quels partenaires sont disponibles

Découvrir les Factures

Lancez une découverte de factures

Vue d'ensemble Bill Payment

Comment tout le flux s’articule

Tests en Sandbox

Testez chaque issue avant la mise en production

Référence API

Core

Compte

Recharges mobiles

Recharges internet

Cartes cadeaux

Navio

Paiement de factures

Valider la Clé API

Vue d’ensemble

Réponse

Exemples

Réponse de succès

Réponses d’erreur

Confirmer votre environnement avant la mise en production

Ce que cet endpoint ne retourne pas

Bonnes pratiques

Appeler au Démarrage

Ne Jamais Journaliser la Clé

Séparer les Deux Clés

Traiter le 503 comme Transitoire

Endpoints associés

Lister les Partenaires

Découvrir les Factures

Vue d'ensemble Bill Payment

Tests en Sandbox

​Vue d’ensemble

​Réponse

​Exemples

​Réponse de succès

​Réponses d’erreur

​Confirmer votre environnement avant la mise en production

​Ce que cet endpoint ne retourne pas

​Bonnes pratiques

Appeler au Démarrage

Ne Jamais Journaliser la Clé

Séparer les Deux Clés

Traiter le 503 comme Transitoire

​Endpoints associés

Lister les Partenaires

Découvrir les Factures

Vue d'ensemble Bill Payment

Tests en Sandbox

Vue d’ensemble

Réponse

Exemples

Réponse de succès

Réponses d’erreur

Confirmer votre environnement avant la mise en production

Ce que cet endpoint ne retourne pas

Bonnes pratiques

Endpoints associés