Python SDK

pip install https://inlineshield.io/downloads/sdk/inlineshield-1.0.0-py3-none-any.whl
# or the source distribution: pip install https://inlineshield.io/downloads/sdk/inlineshield-1.0.0.tar.gz

import os
from inlineshield import Client

# Server-side only: your secret key (bs_live_… or bs_test_…) from the console, Settings › Keys.
shield = Client(
    os.environ["INLINESHIELD_API_KEY"],
    timeout_ms=3000,  # per request (the default)
    fail_open=True,   # the default: an outage gives an "unavailable" result with action "allow"
)

import os
from flask import request
from inlineshield import Client

shield = Client(os.environ["INLINESHIELD_API_KEY"])


def screen_signup():
    """In your sign-up view (Flask): the browser script put the token in the form."""
    email = request.form["email"]
    checked = shield.siteverify(request.form.get("betshield_token"), email)
    if checked["success"] or checked["unavailable"]:
        return checked
    if checked["error"] == "NO_TOKEN":
        # The script was blocked, timed out or is missing: screen on the server instead.
        return shield.verify(email, ip=request.remote_addr, user_agent=request.headers.get("User-Agent", ""))
    return {"action": "block", "error": checked["error"]}  # INVALID_TOKEN, EXPIRED_TOKEN, ...


result = screen_signup()
if result["action"] == "allow":
    pass  # create the account
elif result["action"] == "hold":
    pass  # create it pending and keep result.get("reviewId") (live holds)
else:
    pass  # reject the sign-up

import os
from flask import request
from inlineshield import Client

shield = Client(os.environ["INLINESHIELD_API_KEY"])

result = shield.verify(
    request.form["email"],
    ip=request.remote_addr,                            # the player's IP, not your server's
    user_agent=request.headers.get("User-Agent", ""),  # the player's browser
    username=request.form.get("username"),             # optional
)
# result["action"]: "allow", "hold" or "block"; result["riskScore"] 0-100; result["reasons"]
if result["unavailable"]:
    pass  # InlineShield could not answer: action is "allow" (fail-open); result["error"] says why

import os
from inlineshield import Client

shield = Client(os.environ["INLINESHIELD_API_KEY"])

# By the requestId InlineShield returned (accepted for screenings up to 180 days old):
sent = shield.feedback(request_id, "fraud", category="bonus_abuse", note="Chargeback on first deposit")
# Or by the browser token, for about a day after the screening:
shield.feedback({"token": token}, "legit", category="good_customer")
# sent["changed"] is False when the same feedback was already recorded.

import os
from inlineshield import Client

shield = Client(os.environ["INLINESHIELD_API_KEY"])

# The reviewId of a held sign-up. Webhooks tell you first; this is the fallback.
review = shield.get_review(review_id)
if review["status"] == "approved":
    pass  # activate the account
elif review["status"] == "rejected":
    pass  # delete or disable it (review["decisionReason"]: "operator" or "expired")

import os
from flask import abort, request
from inlineshield import WebhookVerificationError, verify_webhook

# app is your Flask application: app = Flask(__name__)


@app.post("/inlineshield/webhook")
def inlineshield_webhook():
    try:
        event = verify_webhook(
            request.headers.get("X-InlineShield-Signature"),
            request.get_data(),  # the raw body bytes, before any JSON parsing
            os.environ.get("INLINESHIELD_WEBHOOK_SECRET"),
        )
    except WebhookVerificationError:
        abort(400)
    if event["event"] == "signup.approved":
        pass  # activate the account that has reviewId event["data"]["reviewId"]
    elif event["event"] == "signup.rejected":
        pass  # delete or disable it (event["data"]["decisionReason"])
    # Deliveries can repeat: make this idempotent (key on event["id"]).
    return "", 200

import os
from flask import request
from inlineshield import ApiError, AuthError, Client, QuotaError, RateLimitError, UnavailableError

shield = Client(os.environ["INLINESHIELD_API_KEY"])

try:
    result = shield.verify(request.form["email"], ip=request.remote_addr,
                           user_agent=request.headers.get("User-Agent", ""))
    if result["unavailable"]:
        pass  # fail-open: result["error"] is TIMEOUT, UNAVAILABLE, RATE_LIMIT_EXCEEDED, TEST_LIMIT or QUOTA_EXCEEDED
except AuthError as err:
    # INVALID_API_KEY, EXPIRED_API_KEY, TENANT_SUSPENDED...: fix the configuration (raised even with fail_open).
    raise RuntimeError("InlineShield is not configured: " + err.code) from err
except ApiError as err:
    # The request was refused: err.code (e.g. INVALID_IP) and err.status.
    raise

# Fail-closed instead: with fail_open=False an outage raises.
strict = Client(os.environ["INLINESHIELD_API_KEY"], fail_open=False)
try:
    strict.verify(request.form["email"], ip=request.remote_addr, user_agent=request.headers.get("User-Agent", ""))
except (UnavailableError, RateLimitError, QuotaError):
    pass  # InlineShield is unavailable: reject the sign-up, or ask the player to try again (retry_after on a rate limit)