Emailage API client written in Python
Project description
The Emailage™ API is organized around REST (Representational State Transfer). The API was built to help companies integrate with our highly efficient fraud risk and scoring system. By calling our API endpoints and simply passing us an email and/or IP Address, companies will be provided with real-time risk scoring assessments based around machine learning and proprietary algorithms that evolve with new fraud trends.
Getting Started
Requirements
Python 2.7+ or 3.3+
Installation
Emailage can be installed with pip:
$ pip install emailage-official
or directly from the source code:
$ git clone https://github.com/emailage/Emailage_Python.git $ cd Emailage_Python $ python setup.py install
Usage
Instantiate a client
from emailage.client import EmailageClient
# For a production server
emailage = EmailageClient('My account SID', 'My auth token')
# ... or for a sandbox
emailage = EmailageClient('My account SID', 'My auth token', sandbox=True)
Query a risk score information for the provided email address, IP address, or a combination
# For an email address
emailage.query('test@example.com')
# For an IP address
emailage.query('127.0.0.1')
# For a combination. Please note the order
emailage.query(('test@example.com', '127.0.0.1'))
# Pass a User Defined Record ID.
# Can be used when you want to add an identifier for a query.
# The identifier will be displayed in the result.
emailage.query('test@example.com', urid='My record ID for test@example.com')
Explicit methods produce the same request while validating format of the arguments passed
# For an email address
emailage.query_email('test@example.com')
# For an IP address
emailage.query_ip_address('127.0.0.1')
# For a combination. Please note the order
emailage.query_email_and_ip_address('test@example.com', '127.0.0.1')
# Pass a User Defined Record ID
emailage.query_email_and_ip_address('test@example.com', '127.0.0.1', urid='My record ID for test@example.com and 127.0.0.1')
# Mark an email address as fraud because of Synthetic ID.
emailage.flag('fraud', 'test@example.com', 8)
emailage.flag_as_fraud('test@example.com', 8)
# Mark an email address as good.
emailage.flag('good', 'test@example.com')
emailage.flag_as_good('test@example.com')
# Unflag an email address that was previously marked as good or fraud.
emailage.flag('neutral', 'test@example.com')
emailage.remove_flag('test@example.com')
Exceptions
This gem can throw exceptions on any of the following issues:
When Requests has an issue, like not being able to connect from your server to Emailage API,
When bad formatted JSON is received,
When an incorrect email or IP address is passed to a flagging or explicitly querying method.
2.0.0
The revision is created from scratch for the new API version.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for emailage_official-1.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a119c18a8074a2abde10bf6d558673d68253ec49b4ac402cfdd005822e847489 |
|
MD5 | 3c6bf3621ddb013d731447951e124c55 |
|
BLAKE2b-256 | f24a644ff1e89379f85cabbc9f2dd9fae1c5827c8f6345941fe987fa703a03dc |