Takardun API na AfricaProxies

Tabbatar da shiga

Kowace buƙata banda kundin jama'a tana ɗauke da maɓallin API: Authorization: Bearer API_KEY. Ana nuna maɓalli cikakke sau ɗaya, lokacin ƙirƙirarsa: adana shi kamar kalmar sirri. Soke maɓalli a kowane lokaci; buƙatun da aka yi da shi daga nan suna mayar da 401 unauthorized.

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

Buƙatu da amsoshi

• JSON shiga, JSON fita: aika Content-Type: application/json tare da jiki.
• Jerin bayanai masu iya ƙaruwa ana raba su shafuka da page (daga 1) da perPage (1–100, tsohon saiti 20), suna mayar da { "data": [...], "pagination": { "page", "perPage", "total", "totalPages" } }. Gajerun jerin suna mayar da { "data": [...] }.
• Alamomin ganewa igiyoyin rubutu ne marasa ma'anar da za a fassara, masu farkon alamar nau'i: ord_ (oda), top_ (cika asusu), txn_ (motsin kuɗin asusu), res_ (biyan traffic), mob_ (toshin mobile), key_ (maɓallin API) da ipw_ (shigar jerin IP da aka amince da su).
• Sake gwadawa cikin aminci: POST /v1/orders da POST /v1/topups suna karɓar taken Idempotency-Key (kowace igiyar rubutu ta musamman, ana riƙe ta 24 h). Sake amfani da maɓallin ɗaya yana mayar da amsar farko maimakon sake saye ko cika asusu sau biyu.
• Misalai suna nuna tsarin kowace amsa: alamomin ganewa, adiresoshi, adadi da kwanakin cikinsu na misali ne; alamomin tsare-tsare da farashinsu na gaskiya ne.

Kurakurai

Kowane kuskure yana da jiki iri ɗaya. code tabbatacce ne don shirinka; message jimlar Turanci ce mai iya sauyawa. Kurakuran tabbatarwa suna jera kowane filin da bai inganta ba a fields. Ana iya ƙara sabbin lambobin kuskure: ɗauki wanda ba a sani ba a matsayin gazawa gaba ɗaya.

{
  "error": {
    "code": "validation_failed",
    "message": "Some fields are invalid.",
    "fields": [
      {
        "field": "amountUsd",
        "code": "too_small",
        "message": "The minimum top-up is 25.00 USD."
      }
    ],
    "requestId": "req_2b7c0f"
  }
}

Iyakokin yawan kira

Kowace amsa tana ɗauke da RateLimit-Limit, RateLimit-Remaining da RateLimit-Reset. Idan an wuce iyaka, API yana amsa 429 rate_limited tare da taken Retry-After (daƙiƙa): jira wannan lokacin, sannan sake gwadawa. Ana iya sauya IP na toshin mobile aƙalla tazarar daƙiƙa 30 (429 rotation_too_soon, tare da Retry-After).