Giters

fingerprintjs / BotD

Bot detection library that runs in the browser. Detects automation tools and frameworks. No server required, runs 100% on the client. MIT license, no usage restrictions.

Home Page:https://fingerprintjs.github.io/BotD/main/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Improve server API docs

Valve opened this issue · comments

commented
  1. Explain why we need to call the server API in one sentence (it's a server-to-server, secure way of getting the botd results back).
  2. Get rid of the the POST /detect section entirely (but copy the response format to GET /results), because users will not be using that.
  3. Explain that you need to detect client-side first, get requestID and then get results with GET /results on the server second, passing the requestID
  4. Make the server API docs read like a book from top to bottom so that a developer is able to quickly solve their server use case w/out having to jump in the document (make most important information to be at the top, not at the bottom).
    /cc @makma
commented

btw the server api docs need to update, I found that the new parameter verifyCounter: 1 is very confusing, what does it mean?

commented

and in order to avoid false positives, what range of probability scores can I consider the client to be a human? for example, less than 0.2? I think this need to be carefully written in the docs as well.
Thx

commented

@tvvocold thanks for your suggestions. I've added this information to Server API docs.