This is my mock-up of an API designed for push notifications via Wiimmfi. Users would be able to enable the service and select an URL (or a manual URL). USers will be able to select either GET or POST; the service provider would state what to use (or a provided URL would state if GET or POST). All API calls would use the same name (ie URL/test, URL/online).
Wiimmfi - Test API:
URL.TLD/API/test
Returns either GET or POST.
When a user comes online (NAS + GPCM):
POST URL.TLD/API/online
User=PID&Game=ID4
/or/
GET URL.TLD/API/online?user=PID&game=ID4
When a user goes offline (GPCM):
POST URL.TLD/api/offline
User=PID&Game=ID4
/or/
GET URL.TLD/API/offline?user=PID&game=ID4
If a user is searching (this is per game and per user)
POST URL.TLD/API/search
User=PID&Game=ID4&Type=SEARCH-TERMS-OR-TYPE.
/or/
GET URL.TLD/API/search?User=PID&Ga…Type=SEARCH-TERMS-OR-TYPE
This is clearly a mockup, and will not be final, in fact I feel that my API may be blunt.
Wiimmfi - Test API:
URL.TLD/API/test
Returns either GET or POST.
When a user comes online (NAS + GPCM):
POST URL.TLD/API/online
User=PID&Game=ID4
/or/
GET URL.TLD/API/online?user=PID&game=ID4
When a user goes offline (GPCM):
POST URL.TLD/api/offline
User=PID&Game=ID4
/or/
GET URL.TLD/API/offline?user=PID&game=ID4
If a user is searching (this is per game and per user)
POST URL.TLD/API/search
User=PID&Game=ID4&Type=SEARCH-TERMS-OR-TYPE.
/or/
GET URL.TLD/API/search?User=PID&Ga…Type=SEARCH-TERMS-OR-TYPE
This is clearly a mockup, and will not be final, in fact I feel that my API may be blunt.