Web API and Webhooks in rewrite

[perryprog]

Assuming we will save all transcriptions in a db in the upcoming rewrite, it would be nice to expose an API that would allow other bots (namely ToR-Stats, soon to be merged with ToR Genius) to do computations and show information about someones transcriptions. Possible endpoints:

• /:user → Info on a certain Redditor, like total transcriptions, or other info
• /:user/transcriptions → Get a list of all user transcriptions
• /:user/transcriptions?extra=true → Get a list of all user transcriptions, including the post contents (so it's easily searchable)

A system like that should be relatively easy to implement, and could also lead to more automation with things like role assigns in Discord.

Another thing to thing about is adding webhooks. Basically we could make a request to a list of URLs when a certain event occurs like "transcription marked done", or "user moved up a transcription rank". This could also help with some automation on the Discord.

---

All of this is relatively easy to implement, so we can probably add this in v4.0.0.

[NGTmeaty]

Gotta say, this sounds like a pretty solid idea. 👍

…

On Wed, Mar 21, 2018 at 11:41 PM, Perry Fraser ***@***.***> wrote: Assuming we will save all transcriptions in a db in the upcoming rewrite, it would be nice to expose an API that would allow other bots (namely ToR-Stats, soon to be merged with ToR Genius) to do computations and show information about someones transcriptions. Possible endpoints: - /:user → Info on a certain Redditor, like total transcriptions, or other info - /:user/transcriptions → Get a list of all user transcriptions - /:user/transcriptions?extra=true → Get a list of all user transcriptions, including the post contents (so it's easily searchable) A system like that should be relatively easy to implement, and could also lead to more automation with things like role assigns in Discord. Another thing to thing about is adding webhooks. Basically we could make a request to a list of URLs when a certain event occurs like "transcription marked done", or "user moved up a transcription rank". This could also help with some automation on the Discord. ------------------------------ All of this is relatively easy to implement, so we can probably add this in v3.5.0 (I think that's the right version, a bit tired right now). — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://github.com/GrafeasGroup/tor/issues/109>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACI_p3DotMy2pmddqpKt6G6vcvU2mBFyks5tgx1ggaJpZM4S2Z8L> .

[DavidArchibald]

Any thoughts on auth though? Should we even bother? It's not exactly too confidental, but auth would still probably be good just to prevent overuse and or tracking of people who use it. I know for sure I'd use this though if it's implemented.

[itsthejoker]

I've already implemented the GET portion of the API and am working on auth now; we'll have a full API key system where you just pass your key in with your request and the API will validate it.