Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Nesze committed Apr 19, 2024
1 parent 6a569a9 commit 2709c48
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ go get github.com/utilitywarehouse/castle-go
castle.NewWithHTTPClient("secret-api-key", &http.Client{Timeout: time.Second * 2})
```

## API notes
## API

The pkg wraps the two [Risk Assessment endpoints](https://reference.castle.io/#tag/risk_assessment) of the Castle API: Risk and Filter.

Expand All @@ -29,7 +29,7 @@ The right usage of the Filter API and rest of the technical differences are laid
All in all, use Filter API for anonymous user events, and Risk API for logged in users.
The model of the endpoints is almost the same, the request is almost identical while the response is 100% is. Both return risk assessment scores, which depending on the flow (event and status) might be ignored.

#### NOTE
#### Notes

The [Log API](https://reference.castle.io/#tag/logging) is currently not exposed in this pkg, as it is not a risk assessment endpoint, therefore the general risk scoring is not affected by it:

Expand All @@ -38,3 +38,7 @@ The [Log API](https://reference.castle.io/#tag/logging) is currently not exposed

> Note that these can also be sent to the Log API, but that would degrade risk scoring performance since the risk score isn't evaluated for Log events
[2](https://docs.castle.io/docs/anonymous-activity)

## Repo

Originally forked from [castle/castle-go](https://github.com/castle/castle-go) now it lives on its own. The original repo has not been maintained, and as of today only supports long deprecated Castle APIs.

0 comments on commit 2709c48

Please sign in to comment.