REST API v1.0
Nyaraka za API
Unganisha WiFiHapa kwenye programu zako. Simamia router, watumiaji, malipo, na uchambuzi kwa njia ya programu.
Uthibitishaji
Maombi yote ya API yanahitaji ufunguo wa API. Ijumuishe kwenye kichwa cha ombi:
Authorization: Bearer YOUR_API_KEY
Pata ufunguo wako wa API kutoka kwenye ukurasa wa Mipangilio ya Msanidi
URL ya Msingi
https://api.wifihapa.co.tz/v1/
Ncha za Mwisho
📡 Routa
GET
/routers
Orodhesha routa zote zinazopatikana karibu na eneo.
GET /v1/routers?lat=-6.7924&lon=39.2083&radius=100
GET
/routers/{id}
Pata maelezo ya routa maalum.
GET /v1/routers/123
⏱️ Vipindi
POST
/sessions
Unda kipindi kipya cha WiFi (nunua muda).
POST /v1/sessions\n{\n "router_id": 123,\n "duration": "1h",\n "payment_method": "vodacom",\n "phone": "0712345678"\n}
GET
/sessions/{id}
Pata hali ya kipindi na nenosiri.
GET /v1/sessions/456
DELETE
/sessions/{id}
Maliza kipindi kinachoendelea.
DELETE /v1/sessions/456
💰 Malipo
POST
/payments/mpesa
Anza malipo ya M-Pesa.
POST /v1/payments/mpesa\n{\n "amount": 500,\n "phone": "0712345678",\n "session_id": 456\n}
GET
/payments/{id}/status
Angalia hali ya malipo.
GET /v1/payments/789/status
📊 Mmiliki wa Router
GET
/owner/earnings
Pata muhtasari wa mapato ya kila siku/wiki/mwezi.
GET /v1/owner/earnings?period=weekly
GET
/owner/users
Orodhesha vipindi vilivyo hai na vilivyoisha kwenye routa zilizomilikiwa.
GET /v1/owner/users
PUT
/owner/routers/{id}/price
Sasisha bei ya kila saa ya router.
PUT /v1/owner/routers/123/price\n{ "price": 550 }
🔔 Ndoano za Wavuti
POST
/webhooks/register
Sajili URL ya ndoano ya wavuti kwa matukio.
POST /v1/webhooks/register\n{ "url": "https://yourdomain.com/webhook", "events": ["payment.success", "session.expired"] }
Misimbo ya Majibu
200 Imefanikiwa
201 Imeundwa
400 Ombi Baya
401 Haijaidhinishwa
403 Imekatazwa
404 Haijapatikana
429 Kikomo cha Kiwango Kimezidi
500 Hitilafu ya Ndani ya Seva
Vikomo vya Kiwango
Kikomo cha msingi cha kiwango: Maombi 100 kwa dakika kwa kila ufunguo wa API
Mpango wa Biashara: Maombi 1000 kwa dakika