Annual Ads

Dokumentazzjoni għall-iżviluppaturi

Ibni direttament fuq il-pjattaforma Annual Ads — oħloq reklamaturi, ippubblika reklami, inċaħħad il-ħlasijiet, u ssegwi r-rank, kollox permezz tal-API.

Ara l-grilja sħiħa tal-prezzijiet

Int iżżomm 70% ta' dak li jħallsu l-inserzjonisti tiegħek fil-modalità Connect għall-inserzjonijiet tagħhom — imħallas awtomatikament fil-portafoll tiegħek. Ara kif jaħdem hawn taħt.

URL bażiku

https://api.adhub365.com
OpenAPI 3

Awtentikazzjoni

Kull talba tiġi awtentikata b'ċavetta sigrieta fil-header tal-Awtorizzazzjoni, billi tuża l-iskema Bearer.

POST https://api.adhub365.com/v1/partner/ads
Authorization: Bearer sk_sandbox_...
Content-Type: application/json

Sandbox u produzzjoni

Il-chiavi tas-sandbox u tal-produzzjoni huma kompletament isolati minn xulxin — il-chiavi tas-sandbox qatt ma jistgħu jaqraw jew jiktbu data maħluqa mill-chiavi tal-produzzjoni, u viċi versa.

Qasamijiet ta' studju

Kull ċavetta hija limitata għall-ambiti li ngħatat magħhom — ċavetta qatt m'għandhiex aċċess akbar mill-kont tal-partner li ħolqitha.

Iċ-ċwievet tal-API jingħataw lil kontijiet ta' sħab approvati mit-tim tal-Reklami Annwali.

Oħloq kont ta' sieħeb

Qsim tad-dħul mill-irklami

Jekk iċ-ċwievet tal-API tiegħek joħolqu kontijiet ta' reklamaturi għall-utenti tiegħek stess (modalità Connect — ara l-Awtentikazzjoni hawn fuq), inti tirbaħ sehem minn dak li jħallsu dawk ir-reklamaturi għall-irklami tagħhom. Il-qsim hawn taħt jinqara direttament minn dan l-istess endpoint, qatt ma jkun hardcoded, u huwa kompletament separat mill-kommissjoni tar-referenza li tinsab aktar 'il isfel f'din il-paġna.

GET https://api.adhub365.com/v1/partner-program
{
  "partner_share_percentage": 0.7,
  "platform_share_percentage": 0.3
}

70%

Jmur għandek

Imħallas awtomatikament fil-wallet tal-ħlas li kkonfigurajt — m'hemmx bżonn ta' talba ta' rtirar.

30%

Imur għall-Reklammi Annwali

Jkopri l-moderazzjoni, l-ospitar u l-infrastruttura tar-rankjar li fuqha jaħdmu l-inserzjonijiet tiegħek.

Kif taħdem

  1. Wieħed mill-inserzjonisti tiegħek fil-modalità Connect iħallas għal reklama permezz tal-integrazzjoni tiegħek.
  2. Ir-reklama tiġi riveduta u approvata — awtomatikament, jew mit-tim tagħna għall-moderazzjoni.
  3. Il-parteċipazzjoni tiegħek tinsab fil-kju għall-ħlas awtomatiku fil-wallet tiegħek, bl-istess mekkaniżmu bħal dak tal-programm ta' referenza hawn taħt.
Sehem qatt ma jinħoloq qabel ma l-ir-reklama tkun approvata — jekk il-moderazzjoni tirrifjutaha, m'hemm xejn dovut fuq dik il-ħlas. Żieda fuq reklama diġà attiva ma ġġorr l-ebda riskju bħal dan u tiġi maqsuma immedjatament.

Kundizzjonijiet tal-ħlas

  • Portafoll ta' ħlas kripto huwa kkonfigurat fuq il-kont tal-partner tiegħek.
  • Mhux meħtieġ KYC min-naħa tiegħek — il-kont tal-partner tiegħek diġà ġie vverifikat meta nħoloq.

Eżempju: qari tal-ishma akkumulati

GET https://api.adhub365.com/v1/partner/ad-revenue/earnings
Authorization: Bearer sk_sandbox_...
{
  "shares": [
    {
      "id": "share_1a2b...",
      "payment_id": "pay_9f2a...",
      "ad_id": "ad_7c31...",
      "partner_amount_usd": 140.0,
      "platform_amount_usd": 60.0,
      "status": "paid",
      "payable_after": "2026-08-03T00:00:00Z",
      "paid_at": "2026-08-05T10:12:00Z"
    }
  ],
  "total_payable_pending_usd": 0.0,
  "total_payable_usd": 0.0,
  "total_processing_usd": 0.0,
  "total_paid_usd": 140.0
}

Punti finali

Kontijiet

POST/v1/partner/advertisers

Oħloq kont ta' reklamatur f'isem wieħed mill-utenti tiegħek (modalità Connect).

advertisers:write
GET/v1/partner/advertisers/{id}

Fittex kont ta' reklamatur maħluq minn dan il-partner.

advertisers:read

Reklammi

POST/v1/partner/ads

Oħloq reklama. Tibda f'status ta' abbozz. Kampijiet fakultattivi advertiser_type, promotion_type, link_type, u promoted_brand jiddeskrivu reklamar ta' affiljat, ta' referiment, ta' kreatur, jew individwali — ara n-nota hawn taħt.

ads:write
GET/v1/partner/ads/{id}

Fittex reklama.

ads:read
PATCH/v1/partner/ads/{id}

Aġġorna l-kontenut editorjali — titlu, deskrizzjoni, link, tip ta' reklamatur, tip ta' promozzjoni, tip ta' link, u marka promossa. Kategorija, ġeografija, u kull ħaġa li l-magna tar-rankjar taqra ma jistgħux jinbidlu hawn.

ads:write
POST/v1/partner/ads/{id}/image

Itella' immaġni ta' reklamar direttament (JPEG/PNG/WebP, massimu ta' 5 MB). Meħtieġ qabel l-ewwel ħlas — ara l-grupp tal-ħlasijiet hawn taħt.

ads:write
POST/v1/partner/ads/{id}/image-url

Issettja l-immaġni ta' reklama minn URL minflok ittella' fajl — is-server jieħuha u jerġa' jospitaha hu stess. L-istess rekwiżit: meħtieġ qabel l-ewwel ħlas.

ads:write
GET/v1/partner/ads/{id}/rank

Il-klassifikazzjoni attwali, il-kategorija u l-ambitu ġeografiku għal reklama.

ads:read
GET/v1/partner/ads/{id}/stats

Il-veduti totali u l-klikks għal reklama — il-jiem li għaddew/li fadal jiġu mill-kampijiet activated_at u expires_at diġà fuq GET /{id}, u r-rank jiġi minn GET /{id}/rank.

ads:read

Ħlasijiet

POST/v1/partner/payments

Ibda ħlas kripto għal xiri inizjali jew top-up. Ħlas inizjali jonqos bil-kodiċi 422 sakemm l-ad diġà jkollu immaġni — ara uploadAdImage/setAdImageUrl hawn fuq.

payments:write
GET/v1/partner/payments/{id}

Iċċekkja l-istatus ta' ħlas.

payments:read

Riferimenti

POST/v1/partner/referrals

Oħloq link ta' referenza.

referrals:write
GET/v1/partner/referrals/{code}/earnings

Dħul kumulattiv mir-riferimenti, maqsum skont l-istatus.

referrals:read

Qsim tad-dħul mill-irklami

GET/v1/partner/ad-revenue/earnings

Il-70% sehem tiegħek minn dak li ħallsu l-inserzjonisti li ħloqt fil-modalità Connect għall-irklami tagħhom, imqassam skont l-istatus.

ad-revenue:read

Reġistru ta' aċċess

GET/v1/partner/access-log

L-istorja sħiħa tas-sejħiet għal din il-metodu key — path, IP, timestamp.

Hemm

Punti finali pubbliċi

GET/v1/rankings?category={id}&geo={scope}

Klassifika ta' qari biss għal kategorija u skop ġeografiku.

Pubbliku
GET/v1/tiers

Is-7 livelli ta' prezz konfigurati (limitu, benefiċċji miftuħa).

Pubbliku
GET/v1/referral-program

Il-perċentwali tal-kummissjoni li bħalissa huma attivi għall-kaskata tar-riferiment u għall-Pool tal-Mexxejja.

Pubbliku
GET/v1/partner-program

Il-qsim attwali tad-dħul mill-irklami (modalità Connect) bejnek u Annual Ads.

Pubbliku
GET/v1/search?q={query}

Tfittxija bil-lingwa naturali — tiddirezzjona mistoqsija bħal "reklamaturi tal-għamara fil-Kenja" lejn il-kategorija u l-ambitu ġeografiku korrispondenti, u mbagħad tirritorna dak ir-rankjar fl-ordni eżatta tiegħu.

Pubbliku

Reklamar ta' affiljati u ta' referiment

advertiser_type, promotion_type, link_type, u promoted_brand huma kampijiet fakultattivi fuq POST u PATCH /v1/partner/ads — Annual Ads mhix limitata għal negozji li jirreklamaw lilhom infushom. Meta link_type ikun affiliate_link jew referral_invitation_link, jew promotion_type ikun affiliate_offer jew referral_opportunity, affiliate_terms_accepted għandu jkun true, inkella t-talba tiġi miċħuda b'422. It-titlu huwa limitat għal 35 karattru u d-deskrizzjoni għal 80 — iż-żewġ limiti jiġu infurzati fuq in-naħa tas-server, mhux biss fl-UI tad-dashboard.

Għodod tal-AI

Kull kont ta' reklamatur jirċievi sett ta' għodod ta' intelliġenza artifiċjali integrati — ġeneratur ta' kontenut u viżwali għall-irklami, assistent konversazzjonali, konsulent tal-baġit, u awditur estern tas-SEO — imħallsa bil-krediti tal-IA, fuq il-prezz annwali fiss.

Dawn jgħaddu permezz tal-login tad-dashboard tal-inserzjonist stess (token ta' aċċess tas-sessjoni), mhux permezz ta' ċavetta API ta' sieħeb — integrazzjoni ta' parti terza ma tistax sejħilhom f'isem l-inserzjonist.
POST/v1/advertisers/{id}/ai/assistant

Ask Annual Ads — assistent konversazzjonali flottanti, informattiv biss, biss għall-qari tad-dejta tal-kont.

Pubbliku
POST/v1/advertisers/{id}/ai/creative-studio

Ġenera titlu ta' reklama, deskrizzjoni u kliem ewlieni minn deskrizzjoni qasira tan-negozju.

2 kreditu(jiet)
POST/v1/advertisers/{id}/ai/creative-studio/image

Ħloqna immaġni ta' lista (PNG) mid-deskrizzjoni tan-negozju l-istess, ospitata u lesta biex tkun mehmuża ma' reklama.

8 kreditu(jiet)
POST/v1/advertisers/{id}/ai/budget-advisor

Projezzjoni statistika vera — qatt mhuwa stima ġenerattiva — tal-probabbiltajiet li tinżamm rang partikolari f'30/90/365 ijiem.

1 kreditu(jiet)
POST/v1/advertisers/{id}/ai/seo-audit

Analiżża l-websajt esterna tal-irklamatur stess u suġġerixxi titjib konkreti fis-SEO.

2 kreditu(jiet)

Eżempju — ġenera kontenut ta' reklamar

L-istess kategorija u d-deskrizzjoni tan-negozju jipprovdu wkoll il-qawwa lill-ġeneratur tal-immaġni hawn taħt.

POST https://api.adhub365.com/v1/advertisers/{advertiser_id}/ai/creative-studio
Authorization: Bearer <session access token>
Content-Type: application/json

{
  "category_name": "Furniture",
  "business_description": "We sell handmade oak dining tables"
}
{
  "title": "Handmade Oak Dining Tables — Built to Last",
  "description": "Solid oak dining tables crafted by hand, built to last a lifetime.",
  "keywords": ["oak furniture", "dining table", "handmade"],
  "credits_remaining": 8
}

Ġenera viżwal kompatibbli għall-istess reklama:

POST https://api.adhub365.com/v1/advertisers/{advertiser_id}/ai/creative-studio/image
Authorization: Bearer <session access token>
Content-Type: application/json

{
  "category_name": "Furniture",
  "business_description": "We sell handmade oak dining tables"
}
{
  "visual_url": "https://cdn.uploadscenter.com/file_01m1...",
  "credits_remaining": 4
}

Widget

Poġġi unità ta' reklamar lesta fuq is-sit tiegħek — mingħajr bżonn ta' kostruzzjoni, mingħajr iframe. Is-skript tirrendi direttament fil-paġna ġewwa Shadow DOM isolat, sabiex l-istili tiegħu qatt ma jinfiltraw fis-sit tiegħek, u l-istili tas-sit tiegħek qatt ma jinfiltraw fih.

Żidha mal-paġna tiegħek

<div
  class="annualads-widget"
  data-category="YOUR_CATEGORY_ID"
  data-geo="global"
  data-count="4"
  data-columns="2"
></div>
<script async src="https://adhub365.com/widget.js"></script>

B'mod default dan juri l-klassifika pubblika sħiħa tal-kategorija — kull reklamatur fuq il-pjattaforma, mhux biss dawk li ġibt. Biex turi biss ir-reklami minn dawk ir-reklamaturi li ħloqt permezz tal-modalità Connect (dawk li qed jiġġeneraw il-parteċipazzjoni tiegħek), żid data-partner bil-ID tal-partner tiegħek (sibha fuq il-paġna tal-iżviluppaturi fid-dashboard tiegħek):

<div
  class="annualads-widget"
  data-category="YOUR_CATEGORY_ID"
  data-geo="global"
  data-partner="YOUR_PARTNER_ID"
></div>
<script async src="https://adhub365.com/widget.js"></script>

Jekk l-irklamaturi tiegħek jkopru diversi kategoriji, ħalli barra kompletament data-category — bil-data-partner biss, il-widget juri kull wieħed mill-irklami tiegħek f'grilja waħda madwar il-kategoriji kollha, minflok ma jkollok bżonn blokka tal-widget waħda għal kull kategorija:

<div
  class="annualads-widget"
  data-geo="global"
  data-partner="YOUR_PARTNER_ID"
></div>
<script async src="https://adhub365.com/widget.js"></script>

Trid unità b'stil footer ħdejn dik fil-kontenut tiegħek, kull waħda turi reklami differenti? Żid blokka widget t-tieni b'data-layout="compact" (reklama waħda, li tista' tinżel f'pillola żgħira) u issettja data-offset skont kemm reklami diġà turi l-ewwel widget tiegħek:

<!-- in your content -->
<div
  class="annualads-widget"
  data-category="YOUR_CATEGORY_ID"
  data-geo="global"
  data-count="4"
  data-columns="2"
></div>

<!-- in your footer, showing different ads via data-offset -->
<div
  class="annualads-widget"
  data-category="YOUR_CATEGORY_ID"
  data-geo="global"
  data-layout="compact"
  data-offset="4"
></div>
<script async src="https://adhub365.com/widget.js"></script>

Attributi

data-categoryID tal-kategorija li għandha tidher. Meħtieġ — sakemm data-partner ma jkunx issettjat; f'dak il-każ, billi ma tinkludix juri l-irklami tal-partner f'kull kategorija.
data-geoAmbitu ġeografiku: lokali, reġjonali, jew globali. Defaults għal globali.
data-countIn-numru ta' reklami li jidhru. L-issettjar default huwa 4.
data-columnsIn-numru ta' kolonni tal-grilja. Defaults għal 2.
data-layoutgrilja, lista, jew kompatt. Defaults għal grilja. Il-modalità kompatt turi reklama waħda (data-count jiġi injorat) b'buttuna biex tikkollassa f'pillola żgħira u terġa' tirritornaha — unità b'stil footer, li qatt ma tkun pożizzjonata b'mod fiss mis-skript innifsu; inti tpoġġi u tistilja d-div tal-kontenitur kif trid fuq il-paġna tiegħek stess.
data-offsetIn-numru ta' reklami l-aktar għoljin li għandhom jiġu skakkjati. Defaults għal 0. Jippermetti li widget sekondarju fuq l-istess paġna (eż. wieħed kompatt fil-footer u wieħed b'grilja aktar 'il fuq) juri reklami differenti minflok jerġa' juri l-istess reklama darbtejn — agħti n-numru ta' reklami li l-widget l-ieħor diġà qed juri.
data-partnerL-ID tal-partner tiegħek (sibha fuq il-paġna tal-iżviluppaturi fid-dashboard tiegħek). Ovvjament mhux obbligatorju — mingħajrha, il-widget juri r-rankings pubbliċi sħaħ għal dik il-kategorija, għal kull reklamatur fuq il-pjattaforma. Bil-ID, jidhru biss ir-reklami mir-reklamaturi li ġibt permezz tal-modalità Connect — dawk li verament jiġġeneraw is-sehem tiegħek.

Qsim tad-dħul

Kif il-kummissjoni tar-referiment tal-partner fil-fatt tasal għandhom — il-perċentwal, il-mekkaniżmu ta' ħlas, u l-prekundizzjonijiet.

GET https://api.adhub365.com/v1/referral-program
{
  "levels": [
    {
      "level": 1,
      "percentage": 0.1
    }
  ],
  "leaders_pool_percentage_of_gmv": 0.05,
  "founding_advertiser_pool_percentage_of_gmv": 0.05,
  "payout_verification_window_hours": 48,
  "min_payout_usd": 1
}

Mhux numru fiss

Il-perċentwal tal-kummissjoni huwa kkonfigurat min-naħa tagħna u jista' jinbidel — dejjem aqrah live minn dan l-endpoint minflok ma tikkodifika valur b'mod statiku.

Sħiħament awtomatiku

M'hemm l-ebda punt ta' ritirar. Xogħol skedat jiġġenera dħul pagabbli, jorganizzah f'batch għal kull reklamatur, u jħallas awtomatikament ladarba jkunu sodisfatti l-kundizzjonijiet kollha hawn taħt.

Kundizzjonijiet tal-ħlas

  • Il-qligħ totali pagabbli tal-pubblikitarju jilħaq l-ammont minimu ta' ħlas.
  • Portafoll ta' ħlasijiet kripto huwa kkonfigurat fuq il-kont tagħhom.
  • L-istatus KYC tagħhom huwa vverifikat.

Eżempju: qari tad-dħul akkumulat

GET https://api.adhub365.com/v1/partner/referrals/{code}/earnings
Authorization: Bearer sk_sandbox_...
{
  "code": "ann-2f8c",
  "earnings": [
    {
      "id": "earn_1a2b...",
      "payment_id": "pay_9f2a...",
      "amount_usd": 30.0,
      "status": "paid",
      "payable_after": "2026-08-01T00:00:00Z",
      "paid_at": "2026-08-03T14:22:00Z"
    }
  ],
  "total_payable_pending_usd": 0.0,
  "total_payable_usd": 0.0,
  "total_processing_usd": 0.0,
  "total_paid_usd": 30.0
}

Livelli tal-prezz (ħaj)

Aqra direttament minn dan l-endpoint — qatt ma tikteb dawn il-valuri b'mod statiku fil-kodiċi, għax jistgħu jinbidlu min-naħa tagħna. Oħloq picker tal-livell għall-utenti tiegħek minflok kamp ta' ammont b'xejn: kull prezz muri diġà huwa l-ammont eżatt li għandu jiġi mibgħut meta tinħoloq il-ħlas, u l-benefiċċji miftuħa murija hawn jgħidu lill-utenti eżattament x'jiksbu b'dak il-prezz, sabiex jagħżlu prezz li jifhmu minflok jipprova jissuspettaw numru.

LivellPrezzJiftaħ il-blokka
Bronze$50.00

Basic visibility

Silver$300.00

Clickable link unlocked

Rabta li tista' tikklikkja
Gold$500.00

Animation unlocked

Rabta li tista' tikklikkjaAnimazzjoni
Platinum$1,000.00

Enhanced exposure

Rabta li tista' tikklikkjaAnimazzjoni
Diamond$2,500.00

Premium placement

Rabta li tista' tikklikkjaAnimazzjoni
Elite$5,000.00

Top-tier visibility

Rabta li tista' tikklikkjaAnimazzjoni
Legendary$10,000.00

Maximum visibility & branding

Rabta li tista' tikklikkjaAnimazzjoni

Limiti tar-rata

It-talbiet huma limitati għal kull ċavetta kull minuta. Kull risposta awtentikata ġġorr l-intestaturi X-RateLimit-Limit, X-RateLimit-Remaining u X-RateLimit-Reset; meta jitla' l-limitu, tirritorna l-kodiċi 429 Too Many Requests flimkien ma' l-intestatura Retry-After.

Lista ta' permess tal-IP

Ozzjonali, għal kull sieħeb. Sakemm ma żżidx dħul, iċ-ċwievet tiegħek jaċċettaw talbiet minn kwalunkwe IP — id-dħul l-ewwel jibdel iċ-ċwievet kollha ta' dak is-sieħeb għal lista ta' permess biss.

Webhooks

Kull webhook huwa ffirmat b'HMAC-SHA256 billi jintuża sigriet maħruġ darba waħda fil-ħin tal-ħolqien — ivverifika s-sinjatura qabel ma tafda l-payload. L-avvenimenti jintbagħtu biss lill-partner li għandu l-proprjetà tal-inserzjonist relatat.

payment.succeededĦlas ikkonfermat.
payment.refundedIr-rifużjoni titwettaq.
ad.activatedReklama ssir attiva, awtomatikament jew wara reviżjoni mill-amministratur.
invoice.issuedFattura tiġi maħruġa.
referral.payout.completedKummissjoni ta' referenza tilħaq l-istatus imħallas.
referral.payout.failedBatch ta' ħlas ta' referenza jonqos fil-fornitur — id-dħul jerġa' lura fil-kont tal-ħlas u jerġa' jitwettaq.
rank.changedIl-klassifika ta' reklama tinbidel — inkluż meta ħlas ta' reklamatur ieħor jikkawżaha.
ad.expiring_soon30, 7, jew 1 jum qabel reklama tispiċċa.
partner_ad_revenue.payout.completedĦlas ta' qsim tad-dħul mill-irklami jilħaq l-istatus imħallas.
partner_ad_revenue.payout.failedBatch ta' ħlas ta' qsim tad-dħul tal-irklami jonqos fil-fornitur — is-sehem jerġa' lura fil-lista tal-ħlasijiet pendenti u jerġa' jitwettaq.

Kitijiet għall-iżvilupp tas-softwer

L-SDKs uffiċjali ta' JavaScript/TypeScript u Python, ġġenerati minn din l-istess speċifikazzjoni tal-API, huma pjanati iżda għadhom ma ġewx ippubblikati — sa dakinhar, sejjaħ direttament l-API HTTP.

Bidu mgħaġġel

Għad m'hemm l-ebda SDK — dawn iċemplu direttament l-HTTP API u jaħdmu illum f'kull lingwa.

cURL

curl -X POST https://api.adhub365.com/v1/partner/ads \
  -H "Authorization: Bearer sk_sandbox_..." \
  -H "Content-Type: application/json" \
  -d '{"advertiser_id":"adv_9f2a...","category_id":"cat_furniture","geo_scope":"local","title":"..."}'

JavaScript

await fetch("https://api.adhub365.com/v1/partner/ads", {
  method: "POST",
  headers: {
    Authorization: "Bearer sk_sandbox_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    advertiser_id: "adv_9f2a...",
    category_id: "cat_furniture",
    geo_scope: "local",
    title: "...",
  }),
});

Python

import requests

requests.post(
    "https://api.adhub365.com/v1/partner/ads",
    headers={"Authorization": "Bearer sk_sandbox_..."},
    json={
        "advertiser_id": "adv_9f2a...",
        "category_id": "cat_furniture",
        "geo_scope": "local",
        "title": "...",
    },
)