Rejea ya API

Funguo za API na orodha ya IP zinazoruhusiwa

Unda na ubatilishe funguo za API zenye wigo mdogo wa ruhusa, na udhibiti orodha ya IP zinazoruhusiwa: anwani chanzo zisizozidi 10 zinaweza kutumia proxy bila jina la mtumiaji na nenosiri.

Iliyoruushwa mwisho: 15 Oktoba 2026 · 4 dk za kusoma

Vituo vya maombi kwenye ukurasa huu

GET /v1/api-keys: Orodhesha funguo za API
POST /v1/api-keys: Unda ufunguo wa API
DELETE /v1/api-keys/{keyId}: Batilisha ufunguo wa API
GET /v1/ip-whitelist: Orodhesha IP zinazoruhusiwa
POST /v1/ip-whitelist: Ongeza IP au masafa kwenye orodha inayoruhusiwa
DELETE /v1/ip-whitelist/{entryId}: Ondoa ingizo kwenye orodha inayoruhusiwa

URL ya msingi https://africaproxies.com/api/v1. Uthibitishaji, hitilafu na vikomo: angalia muhtasari wa API.

Orodhesha funguo za API

GET/v1/api-keys

Uthibitishaji: funguo ya API kwenye kichwa cha Authorization: Bearer API_KEY.

Jibu `200 OK`

{
  "data": [
    {
      "id": "key_5n2v8q",
      "name": "Rotation script",
      "prefix": "pk_4f9a2c",
      "scopes": [
        "read",
        "proxies"
      ],
      "createdAt": "2026-10-05T14:03:11Z",
      "lastUsedAt": null
    }
  ],
  "limit": 20
}

Mifano ya kodi

curl

curl -s "https://africaproxies.com/api/v1/api-keys" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/api-keys", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/api-keys`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Unda ufunguo wa API

POST/v1/api-keys

secret kamili inarudishwa mara moja.

Uthibitishaji: funguo ya API kwenye kichwa cha Authorization: Bearer API_KEY.

Mwili wa ombi

Uwanja	Aina	Inahitajika	Maelezo
`name`	string	Ndiyo	herufi zisizozidi 60
`scopes`	array of `read` · `proxies` · `billing`	Ndiyo	—

Mfano

{
  "name": "Rotation script",
  "scopes": [
    "read",
    "proxies"
  ]
}

Jibu `201 Created`

{
  "id": "key_5n2v8q",
  "name": "Rotation script",
  "prefix": "pk_4f9a2c",
  "scopes": [
    "read",
    "proxies"
  ],
  "createdAt": "2026-10-05T14:03:11Z",
  "lastUsedAt": null,
  "secret": "pk_4f9a2c8e1b7d3f6a9c2e5b8d1f4a7c0e"
}

Mifano ya kodi

curl

curl -s -X POST "https://africaproxies.com/api/v1/api-keys" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Rotation script","scopes":["read","proxies"]}'

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.post(f"{API}/api-keys", headers=HEADERS, json={"name": "Rotation script", "scopes": ["read", "proxies"]}, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/api-keys`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Rotation script', scopes: ['read', 'proxies'] }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Batilisha ufunguo wa API

DELETE/v1/api-keys/{keyId}

Uthibitishaji: funguo ya API kwenye kichwa cha Authorization: Bearer API_KEY.

Parameta

Jina	Katika	Aina	Inahitajika	Maelezo
`keyId`	path	string	Ndiyo	—

Jibu `204 No Content`

Hakuna mwili: nambari ya hali ndiyo jibu.

Mifano ya kodi

curl

curl -s -X DELETE "https://africaproxies.com/api/v1/api-keys/key_5n2v8q" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.delete(f"{API}/api-keys/key_5n2v8q", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code)  # 204: done

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/api-keys/key_5n2v8q`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: done

Orodhesha IP zinazoruhusiwa

GET/v1/ip-whitelist

Uthibitishaji: funguo ya API kwenye kichwa cha Authorization: Bearer API_KEY.

Jibu `200 OK`

{
  "data": [
    {
      "id": "ipw_8c1k2m",
      "cidr": "203.0.113.24",
      "label": "Office server",
      "createdAt": "2026-10-05T14:03:11Z"
    }
  ],
  "limit": 10
}

Mifano ya kodi

curl

curl -s "https://africaproxies.com/api/v1/ip-whitelist" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/ip-whitelist", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/ip-whitelist`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Ongeza IP au masafa kwenye orodha inayoruhusiwa

POST/v1/ip-whitelist

Inakubali anwani ya IPv4, CIDR ya IPv4 kutoka /24 hadi /32, anwani ya IPv6 au CIDR ya IPv6 kutoka /48 hadi /128. Masafa binafsi, ya loopback na yaliyohifadhiwa yanakataliwa (422). Inaanza kufanya kazi kwenye lango ndani ya sekunde 60.

Uthibitishaji: funguo ya API kwenye kichwa cha Authorization: Bearer API_KEY.

Mwili wa ombi

Uwanja	Aina	Inahitajika	Maelezo
`cidr`	string	Ndiyo	—
`label`	string	Hapana	herufi zisizozidi 60

Mfano

{
  "cidr": "203.0.113.24",
  "label": "Office server"
}

Jibu `201 Created`

{
  "id": "ipw_8c1k2m",
  "cidr": "203.0.113.24",
  "label": "Office server",
  "createdAt": "2026-10-05T14:03:11Z"
}

Mifano ya kodi

curl

curl -s -X POST "https://africaproxies.com/api/v1/ip-whitelist" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cidr":"203.0.113.24","label":"Office server"}'

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.post(f"{API}/ip-whitelist", headers=HEADERS, json={"cidr": "203.0.113.24", "label": "Office server"}, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/ip-whitelist`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ cidr: '203.0.113.24', label: 'Office server' }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Ondoa ingizo kwenye orodha inayoruhusiwa

DELETE/v1/ip-whitelist/{entryId}

Uthibitishaji: funguo ya API kwenye kichwa cha Authorization: Bearer API_KEY.

Parameta

Jina	Katika	Aina	Inahitajika	Maelezo
`entryId`	path	string	Ndiyo	—

Jibu `204 No Content`

Hakuna mwili: nambari ya hali ndiyo jibu.

Mifano ya kodi

curl

curl -s -X DELETE "https://africaproxies.com/api/v1/ip-whitelist/ipw_8c1k2m" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.delete(f"{API}/ip-whitelist/ipw_8c1k2m", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code)  # 204: done

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/ip-whitelist/ipw_8c1k2m`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: done

Orodhesha funguo za API

Jibu 200 OK

Mifano ya kodi

Unda ufunguo wa API

Mwili wa ombi

Jibu 201 Created

Mifano ya kodi

Batilisha ufunguo wa API

Parameta

Jibu 204 No Content

Mifano ya kodi

Orodhesha IP zinazoruhusiwa

Jibu 200 OK

Mifano ya kodi

Ongeza IP au masafa kwenye orodha inayoruhusiwa

Mwili wa ombi

Jibu 201 Created

Mifano ya kodi

Ondoa ingizo kwenye orodha inayoruhusiwa

Parameta

Jibu 204 No Content

Mifano ya kodi

Kurasa zinazohusiana

Jibu `200 OK`

Jibu `201 Created`

Jibu `204 No Content`

Jibu `200 OK`

Jibu `201 Created`

Jibu `204 No Content`