search

vinceh121 / socialblade-api

Unofficial SocialBlade api
GNU General Public License v3.0
19 stars 5 forks source link

Third-Party Compliant User Agent #1

Closed timcole closed 5 years ago

timcole commented 5 years ago

Although the Social Blade API is private/unofficial for the general pubic with no SLA we do have some business customers who have official supported access with an SLA.

A requirement for those customers is to have a user agent that describes where it's coming from. Can you please change the User-Agent to something like vinceh121's Java Library :: vinceh121/socialblade-api that way if an official access member comes across this they don't breach their agreement by not complying?

If you'd like to included your libs version number in the UA that would actually be even better! :1st_place_medal: e.g. vinceh121's Java Library ( v1.2.3 ) :: vinceh121/socialblade-api

Examples from Libraries used both internally and by official access members https://github.com/TimothyCole/socialblade-js/blob/a368d8f38052fca75db7b8bae29c0b623b7461c7/src/client.ts#L21 https://github.com/TimothyCole/socialblade-go/blob/9137ce01a6d661c30792c655cdc2f5c2f6ede17f/requests.go#L42

vinceh121 commented 5 years ago

Thanks for your input, I will change the User-Agent in the next release.

vinceh121 commented 5 years ago

I have a question: would it be compliant to let the users override the default User-Agent?

timcole commented 5 years ago

As long as the default is complaint then you should be good. If the developer using it changes it to something un-compliant then that's on them. One major reason for this is if we find something wrong with requests we know who to reach out to and we can help them fix anything if its messed up. :)

vinceh121 commented 5 years ago

OK, thanks for reaching out.

timcole commented 5 years ago

Awesome thank you so much! 😄