Bindings for Sift's APIs -- including the Events, Labels, and Score APIs.
Set up a virtual environment with virtualenv (otherwise you will need to make the pip calls as sudo):
virtualenv venv
source venv/bin/activate
Get the latest released package from pip:
Python 2:
pip install Sift
Python 3:
pip3 install Sift
or install newest source directly from GitHub:
Python 2:
pip install git+https://github.com/SiftScience/sift-python
Python 3:
pip3 install git+https://github.com/SiftScience/sift-python
Please see here for the most up-to-date documentation.
Please see the CHANGELOG for a history of all changes.
Note, that in v2.0.0, the API semantics were changed to raise an
exception in the case of error to be more pythonic. Client code will
need to be updated to catch sift.client.ApiException
exceptions.
Here's an example:
import json
import sift.client
client = sift.Client(api_key='<your API key here>', account_id='<your account ID here>')
# User ID's may only contain a-z, A-Z, 0-9, =, ., -, _, +, @, :, &, ^, %, !, $
user_id = "23056"
# Track a transaction event -- note this is a blocking call
properties = {
"$user_id": user_id,
"$user_email": "[email protected]",
"$seller_user_id": "2371",
"seller_user_email": "[email protected]",
"$transaction_id": "573050",
"$payment_method": {
"$payment_type": "$credit_card",
"$payment_gateway": "$braintree",
"$card_bin": "542486",
"$card_last4": "4444"
},
"$currency_code": "USD",
"$amount": 15230000,
}
try:
response = client.track("$transaction", properties)
if response.is_ok():
print "Successfully tracked event"
except sift.client.ApiException:
# request failed
pass
# Track a transaсtion event and receive a score with percentiles in response (sync flow).
# Note: `return_score` or `return_workflow_status` must be set `True`.
properties = {
"$user_id": user_id,
"$user_email": "[email protected]",
"$seller_user_id": "2371",
"seller_user_email": "[email protected]",
"$transaction_id": "573050",
"$payment_method": {
"$payment_type": "$credit_card",
"$payment_gateway": "$braintree",
"$card_bin": "542486",
"$card_last4": "4444"
},
"$currency_code": "USD",
"$amount": 15230000,
}
try:
response = client.track("$transaction", properties, return_score=True, include_score_percentiles=True, abuse_types=["promotion_abuse", "content_abuse", "payment_abuse"])
if response.is_ok():
score_response = response.body["score_response"]
print(score_response)
except sift.client.ApiException:
# request failed
pass
# To include `warnings` field to Events API response via calling `track()` method, set it by the `include_warnings` param:
try:
response = client.track("$transaction", properties, include_warnings=True)
# ...
except sift.client.ApiException:
# request failed
pass
# Request a score for the user with user_id 23056
try:
response = client.score(user_id)
s = json.dumps(response.body)
print s
except sift.client.ApiException:
# request failed
pass
try:
# Label the user with user_id 23056 as Bad with all optional fields
response = client.label(user_id, {
"$is_bad": True,
"$abuse_type": "payment_abuse",
"$description": "Chargeback issued",
"$source": "Manual Review",
"$analyst": "analyst.name@your_domain.com"
})
except sift.client.ApiException:
# request failed
pass
# Remove a label from a user with user_id 23056
try:
response = client.unlabel(user_id, abuse_type='content_abuse')
except sift.client.ApiException:
# request failed
pass
# Get the status of a workflow run
try:
response = client.get_workflow_status('my_run_id')
except sift.client.ApiException:
# request failed
pass
# Get the latest decisions for a user
try:
response = client.get_user_decisions('example_user')
except sift.client.ApiException:
# request failed
pass
# Get the latest decisions for an order
try:
response = client.get_order_decisions('example_order')
except sift.client.ApiException:
# request failed
pass
# Get the latest decisions for a session
try:
response = client.get_session_decisions('example_user', 'example_session')
except sift.client.ApiException:
# request failed
pass
# Get the latest decisions for a piece of content
try:
response = client.get_content_decisions('example_user', 'example_content')
except sift.client.ApiException:
# request failed
pass
# The send call triggers the generation of a OTP code that is stored by Sift and email/sms the code to the user.
send_properties = {
"$user_id": "billy_jones_301",
"$send_to": "[email protected]",
"$verification_type": "$email",
"$brand_name": "MyTopBrand",
"$language": "en",
"$site_country": "IN",
"$event": {
"$session_id": "SOME_SESSION_ID",
"$verified_event": "$login",
"$verified_entity_id": "SOME_SESSION_ID",
"$reason": "$automated_rule",
"$ip": "192.168.1.1",
"$browser": {
"$user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36"
}
}
}
try:
response = client.verification_send(send_properties)
except sift.client.ApiException:
# request failed
pass
# The resend call generates a new OTP and sends it to the original recipient with the same settings.
resend_properties = {
"$user_id": "billy_jones_301",
"$verified_event": "$login",
"$verified_entity_id": "SOME_SESSION_ID"
}
try:
response = client.verification_resend(resend_properties)
except sift.client.ApiException:
# request failed
pass
# The check call is used for verifying the OTP provided by the end user to Sift.
check_properties = {
"$user_id": "billy_jones_301",
"$code": 123456,
"$verified_event": "$login",
"$verified_entity_id": "SOME_SESSION_ID"
}
try:
response = client.verification_check(check_properties)
except sift.client.ApiException:
# request failed
pass
Before submitting a change, make sure the following commands run without errors from the root dir of the repository:
python -m unittest discover
python3 -m unittest discover
For testing the app with real calls it is possible to run the integration testing app, it makes calls to almost all our public endpoints to make sure the library integrates well. At the moment, the app is run on every merge to master
- Add env variable
ACCOUNT_ID
with the valid account id - Add env variable
API_KEY
with the valid Api Key associated from the account - Run the following under the project root folder
# uninstall the lib from the local env (if it was installed)
pip uninstall sift
# install the lib from the local source code
pip install ../sift-python
# run the app
python test_integration_app/main.py