Potential Mockup of Wiimmfi Push API

Billy549 · 22. Mai 2016, 23:26

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.

Reboot · 23. Mai 2016, 07:18

Looking forward to the final release-- looks great so far.

amibu · 23. Mai 2016, 16:42

Whew, that would be great. Parsing HTML pages isn't the best solution.

Wiimm · 23. Mai 2016, 17:00

Using GET/POST is not my understanding of a push service.

Billy549 · 23. Mai 2016, 17:06

The idea is that you GET/POST a site's API links when you want to send them something: Actual PUSH APIs involve the system constantly pulsing, that costs more bandwidth than a send user is online GET/POST.

Plus, if let's say 40 users logged onto MKW in a 30sec period and 30 were part of the API, the API could be told of 30 users coming online in one GET/POST request.

leoetlino · 25. Mai 2016, 16:14

does that mean people who want to use this API will need to implement the API routes (such as /API/test) at their domain? and that POSTs would be triggered on events? That seems more like a webhook system, but it is definitely better than polling or parsing HTML.

Leseratte · 25. Mai 2016, 16:18

That would mean exactly that if Wiimm would implement that. However this is just a suggestion by PokeAcer and nobody knows if a future Wiimmfi API will look like this.

@Wiimm PokeAcer was talking about GET / POST in the other direction - if someone wanted to make an app, he could add his domain to the Wiimmfi settings and Wiimmfi will then send a POST request to that URL every time that event occurs.

leoetlino · 26. Mai 2016, 18:55

Yes, it wouldn't be: clients => Wiimmfi server; but Wiimmfi server => clients. Just a small suggestion, maybe make the URL configurable? This would be more flexible than forcing a specific URL, and is actually the common way to provide a webhook service (that's how GitLab, GitHub, Slack, etc. do it)

aplumafreak500 · 24. Mai 2017, 03:20

Seems like something doable. What I want to see though, is notifications for when someone (in MKW) joins a specific region (such as an arbitrary CT distribution) so if you want to play that pack then, you can hop on and join him/her.

(Apologies for bump)

Potential Mockup of Wiimmfi Push API

Potential Mockup of Wiimmfi Push API

Teilen

Benutzer online 1