قائمة الشركاء

قائمة الشركاء

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

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

fetch('https://billapi.oneclickdz.com/v3/partners', 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/partners",
  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/partners"

	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/partners")

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

GET

partners

قائمة الشركاء

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

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

fetch('https://billapi.oneclickdz.com/v3/partners', 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/partners",
  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/partners"

	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/partners")

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

نظرة عامة

يُرجع حالة توفّر كل مُصدِر فواتير مدعوم. استدعِه قبل الاستكشاف كي تتمكن من إخفاء أي شريك غير متاح عن عملائك بدلًا من تركهم يصطدمون بـ 503 في نهاية النموذج.الاستجابة عبارة عن خريطة مفاتيحها هي قيمة partner نفسها بالضبط التي ترسلها إلى استكشاف الفواتير — بما في ذلك علامات النبر في Algérie Télécom.

يرى مفتاح PRODUCTION حالة التوفّر الحيّة. أما مفتاح SANDBOX فيرى خريطة ثابتة، لأن طلب sandbox لا يصل إلى شريك أبدًا ولأن حالة التوفّر الحيّة ستكون مضلِّلة هناك.

الاستجابة

boolean

مطلوب

true عند إرجاع الخريطة.

object

مطلوب

مُدخَل واحد لكل شريك. مجموعة المفاتيح ثابتة.

إظهار properties

object

Algérienne Des Eaux — المياه.

object

الكهرباء والغاز.

object

مياه الجزائر العاصمة وتيبازة.

object

أقساط السكن.

object

الهاتف الثابت والإنترنت.

لكل مُدخَل حقل واحد:

string

مطلوب

ACTIVE — الاستكشاف والدفع مقبولان.UNAVAILABLE — الاستكشاف والدفع لهذا الشريك يُجيبان بـ 503 PARTNER_UNAVAILABLE.

object

مطلوب

إظهار properties

string

مطلوب

وقت الاستجابة، بتنسيق ISO 8601 UTC.

string

مطلوب

معرّف الربط، يُرسَل أيضًا في ترويسة الاستجابة X-Request-Id.

الأمثلة

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

const response = await fetch("https://billapi.oneclickdz.com/v3/partners", {
  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}`);
}

const available = Object.entries(body.data)
  .filter(([, partner]) => partner.status === "ACTIVE")
  .map(([name]) => name);

console.log(available);

import os
import requests

response = requests.get(
    'https://billapi.oneclickdz.com/v3/partners',
    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']}")

available = [
    name for name, partner in body['data'].items()
    if partner['status'] == 'ACTIVE'
]

print(available)

<?php
$ch = curl_init('https://billapi.oneclickdz.com/v3/partners');
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']);
}

$available = array_keys(array_filter(
    $body['data'],
    fn($partner) => $partner['status'] === 'ACTIVE'
));

print_r($available);
?>

استجابة النجاح

{
  "success": true,
  "data": {
    "ADE": { "status": "ACTIVE" },
    "SONELGAZ": { "status": "ACTIVE" },
    "SEAAL": { "status": "UNAVAILABLE" },
    "AADL": { "status": "UNAVAILABLE" },
    "Algérie Télécom": { "status": "ACTIVE" }
  },
  "meta": {
    "timestamp": "2026-08-31T10:15:32.194Z"
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

استجابات الخطأ

401 — رمز وصول مفقود

لم تُرسَل ترويسة X-Access-Token.

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

ما العمل: أضف الترويسة وأعد المحاولة.

401 — رمز وصول غير صالح

رُفض المفتاح.

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

ما العمل: تحقّق من المفتاح باستخدام التحقق من مفتاح API.

503 — المصادقة غير متاحة

لم نتمكن من التحقق من مفتاحك في الوقت المناسب.

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

ما العمل: أعد المحاولة بعد المدة المحددة في ترويسة Retry-After. وقدّم آخر خريطة مخزّنة مؤقتًا في هذه الأثناء.

503 — الخدمة غير متاحة

واجهة دفع الفواتير في صيانة مُخطّط لها.

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

ما العمل: التزم بـ Retry-After وأعد المحاولة.

حالة التوفّر الحالية

SEAAL وAADL حاليًا UNAVAILABLE في كل من sandbox والإنتاج، والاستكشاف أو الدفع لهما يُجيب بـ 503 PARTNER_UNAVAILABLE. هذا هو الإعداد الحالي للمشغّل، لا قيد دائم — أبقِ الشريكين كليهما في شفرتك ودع هذا endpoint يقرر ما يُعرض.

لا تكتب حالة توفّر أي شريك بشكل ثابت في الشفرة. اقرأ هذه الخريطة، وتعامل مع 503 PARTNER_UNAVAILABLE عند الاستكشاف على أنه شريك أصبح غير متاح بين آخر تحديث لديك وبين الطلب.

تخزين الخريطة مؤقتًا

نادرًا ما تتغير حالة التوفّر. حدّثها وفق مؤقّت بدلًا من تحديثها قبل كل استكشاف، واستمر في تقديم آخر نسخة سليمة عندما يفشل التحديث.

let cache = { map: null, fetchedAt: 0 };
const TTL_MS = 5 * 60 * 1000;

async function getPartners() {
  if (cache.map && Date.now() - cache.fetchedAt < TTL_MS) {
    return cache.map;
  }

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

    const body = await response.json();

    if (body.success) {
      cache = { map: body.data, fetchedAt: Date.now() };
    }
  } catch (error) {
    // Keep serving the previous map rather than blocking the customer.
  }

  return cache.map ?? {};
}

async function isAvailable(partner) {
  const map = await getPartners();
  return map[partner]?.status === "ACTIVE";
}

أفضل الممارسات

خزّن مؤقتًا لبضع دقائق

تخزين مؤقت لمدة 5 دقائق يكفي. استدعاء هذا قبل كل استكشاف يضيف رحلة ذهاب وإياب دون أي فائدة.

أخفِق بلطف عند التحديث

إذا فشل التحديث، فاحتفظ بالخريطة السابقة. قائمة شركاء فارغة أسوأ من قائمة قديمة قليلًا.

استخدم قيمة الشريك بالضبط

أرسل Algérie Télécom بعلامات النبر الخاصة بها. القيمة هي مفتاح هذه الخريطة، حرفًا بحرف.

عالج حالة التسابق

يمكن أن يصبح شريك غير متاح بعد أن خزّنته مؤقتًا. عالج 503 PARTNER_UNAVAILABLE عند الاستكشاف أيضًا.

Endpoints ذات الصلة

التحقق من مفتاح API

تأكّد من مفتاحك ومن بيئتك

استكشاف الفواتير

استعلم عمّا يترتب على حساب ما

الشركاء والحسابات

المعرّفات الخاصة بكل شريك

نظرة عامة على دفع الفواتير

كيف يتكامل التدفق بأكمله

مرجع API

Core

الحساب

شحن الهاتف

شحن الإنترنت

بطاقات الهدايا

Navio

دفع الفواتير

نظرة عامة

الاستجابة

الأمثلة

استجابة النجاح

استجابات الخطأ

حالة التوفّر الحالية

تخزين الخريطة مؤقتًا

أفضل الممارسات

خزّن مؤقتًا لبضع دقائق

أخفِق بلطف عند التحديث

استخدم قيمة الشريك بالضبط

عالج حالة التسابق

Endpoints ذات الصلة

التحقق من مفتاح API

استكشاف الفواتير

الشركاء والحسابات

نظرة عامة على دفع الفواتير

​نظرة عامة

​الاستجابة

​الأمثلة

​استجابة النجاح

​استجابات الخطأ

​حالة التوفّر الحالية

​تخزين الخريطة مؤقتًا

​أفضل الممارسات

خزّن مؤقتًا لبضع دقائق

أخفِق بلطف عند التحديث

استخدم قيمة الشريك بالضبط

عالج حالة التسابق

​Endpoints ذات الصلة

التحقق من مفتاح API

استكشاف الفواتير

الشركاء والحسابات

نظرة عامة على دفع الفواتير

نظرة عامة

الاستجابة

الأمثلة

استجابة النجاح

استجابات الخطأ

حالة التوفّر الحالية

تخزين الخريطة مؤقتًا

أفضل الممارسات

Endpoints ذات الصلة