Official Emailage API client written in Python

These details have not been verified by PyPI

Project links

Homepage

Project description

![alt text](https://www.emailage.com/wp-content/uploads/2018/01/logo- dark.svg)(https://www.emailage.com)

The Python-language Emailage API client helps 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.

Quickstart guide

Requirements

Python 2.7+ or 3.3+

Installation

The Emailage client 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

Typical usage

Instantiate a client

Targeting the production servers

from emailage.client import EmailageClient
client = EmailageClient('My account SID', 'My auth token')

Targeting the sandbox environment

from emailage.client import EmailageClient
client = EmailageClient('My account SID', 'My auth token', sandbox=True)

Query risk score information for the provided email address, IP address,

or a combination

from emailage.client import EmailageClient
client = EmailageClient('My account SID', 'My auth token', sandbox=True)
# For an email address
client.query('test@example.com')
# For an IP address
client.query('127.0.0.1')
# For a combination. Please note the order
client.query(('test@example.com', '127.0.0.1'))
# Pass a User Defined Record ID (URID).
# Can be used when you want to add an identifier for a query.
# The identifier will be displayed in the result.
client.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

from emailage.client import EmailageClient
client = EmailageClient('My account SID', 'My auth token', sandbox=True)
# For an email address
client.query_email('test@example.com')
# For an IP address
client.query_ip_address('127.0.0.1')
# For a combination. Please note the order
client.query_email_and_ip_address('test@example.com', '127.0.0.1')
# Pass a User Defined Record ID
client.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, good, or neutral

You may report that you have found that an email address is good, is associated with fraud, or is neither (neutral).

The call to flag an email address as fraud must be accompanied by one of the fraud reasons enumerated below:

Card Not Present Fraud
Customer Dispute (Chargeback)
First Party Fraud
First Payment Default
Identify Theft (Fraud Application)
Identify Theft (Account Take Over)
Suspected Fraud (Not Confirmed)
Synthetic ID
Other

Mark an email address as fraud because of Synthetic ID

from emailage.client import EmailageClient
client = EmailageClient('My account SID', 'My auth token', sandbox=True)
client.flag('fraud', 'test@example.com', 8)
client.flag_as_fraud('test@example.com', 8)
# Mark an email address as good
client.flag('good', 'test@example.com')
client.flag_as_good('test@example.com')
# Unflag an email address that was previously marked as good or fraud
client.flag('neutral', 'test@example.com')
client.remove_flag('test@example.com')

Exceptions

This client can throw exceptions on any of the following issues:

When Requests has an issue, like not being able to connect from your server to the Emailage API,
When incorrectly-formatted JSON is received,
When an incorrectly-formatted email or IP address is passed to a flagging or explicit querying method.

Client API reference

module `emailage.client`

class `emailage.client.EmailageClient`( secret , token ,

sandbox=False , _tls_version= <SSLMethod.PROTOCOL_TLSv1_2: 5>, timeout=None , http_method='GET' )

Primary proxy to the Emailage API for end-users of the package

Creates an instance of the EmailageClient using the specified credentials and environment

Parameters

secret ( str ) Consumer secret, e.g. SID or API key.
token ( str ) Consumer token.
sandbox ( bool ) (Optional) Whether to use a sandbox instead of a production server. Uses production by default
tls_version (see TlsVersions) (Optional) Uses TLS version 1.2 by default (TlsVersions.TLSv1_2 | TlsVersions.TLSv1_1)
timeout ( float ) (Optional) The timeout to be used for sent requests
http_method (see HttpMethods) (Optional) The HTTP method (GET or POST) to be used for sending requests

Example

>>> from emailage.client import EmailageClient
>>> from emailage import protocols
>>> client = EmailageClient('consumer_secret', 'consumer_token', sandbox=True, tls_version=protocols.TLSv1_1)
>>> fraud_report = client.query(('useremail@example.co.uk', '192.168.1.1'), urid='some_unique_identifier')

Example

>>> from emailage.client import EmailageClient
>>> from emailage import protocols
>>> client = EmailageClient('consumer_secret', 
...                         'consumer_token', sandbox=True, timeout=300)
>>> fraud_report = client.query(('useremail@example.co.uk', '192.168.1.1'), urid='some_unique_identifier')

flag( flag , query , fraud_code=None )

Base method used to flag an email address as fraud, good, or neutral

Parameters

flag ( str ) type of flag you wish to associate with the identifier ( fraud | good | neutral )
query ( str ) Email to be flagged
fraud_code ( int ) (Optional) Required if flag is fraud, one of the IDs in emailage.client.EmailageClient.FRAUD_CODES

Returns

JSON dict of the confirmation response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.flag('good', 'test@example.com')
>>> response_json = client.flag('fraud', 'test@example.com', fraud_code=6)
>>> response_json = client.flag('neutral', 'test@example.com')

flag_as_fraud( query , fraud_code )

Mark an email address as fraud.

Parameters

query ( str ) Email to be flagged
fraud_code ( int ) Reason for the email to be marked as fraud; must be one of the IDs in emailage.client.EmailageClient.FRAUD_CODES

Returns

JSON dict of the confirmation response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.flag_as_fraud('test@example.com', 8)

flag_as_good( query )

Mark an email address as good.

Parameters

query ( str ) Email to be flagged

Returns

JSON dict of the confirmation response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.flag_as_good('test@example.com')

query( query , **params )

Base query method providing support for email, IP address, and optional additional parameters

Parameters

query ( str | ( str , str ) ) RFC2822-compliant Email, RFC791-compliant IP, or both
params ( kwargs ) keyword-argument form for parameters such as urid, first_name, last_name, etc.

Returns

JSON dict of the response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('consumer_secret', 'consumer_token')
>>> response_json = client.query('test@example.com')
>>> # Email address only
>>> response_json = client.query('test@example.com')
>>> # IP Address only
>>> response_json = client.query('209.85.220.41')
>>> # For a combination. Please note the order
>>> response_json = client.query(('test@example.com', '209.85.220.41'))
>>> # Pass a User Defined Record ID (URID) as an optional parameter
>>> response_json = client.query('test@example.com', urid='My record ID for test@example.com')

query_email( email , **params )

Query a risk score information for the provided email address.

Parameters

email ( str ) RFC2822-compliant Email
params ( kwargs ) (Optional) keyword-argument form for parameters such as urid, first_name, last_name, etc.

Returns

JSON dict of the response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.query_email('test@example.com')

query_email_and_ip_address( email , ip , **params )

Query a risk score information for the provided combination of an Email and IP address

Parameters

email ( str ) RFC2822-compliant Email
ip ( str ) RFC791-compliant IP
params ( kwargs ) (Optional) keyword-argument form for parameters such as urid, first_name, last_name, etc.

Returns

JSON dict of the response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.query_email_and_ip_address('test@example.com', '209.85.220.41')

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.query_email_and_ip_address('test@example.com', '209.85.220.41',
...     urid='My record ID for test@example.com and 209.85.220.41')

query_ip_address( ip , **params )

Query a risk score information for the provided IP address.

Parameters

ip ( str ) RFC791-compliant IP
params ( kwargs ) (Optional) keyword-argument form for parameters such as urid, first_name, last_name, etc.

Returns

JSON dict of the response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.query_ip_address('209.85.220.41')

remove_flag( query )

Unflag an email address that was marked as good or fraud previously.

Parameters

query ( str ) Email to be flagged

Returns

JSON dict of the confirmation response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('My account SID', 'My auth token', sandbox=True)
>>> response_json = client.remove_flag('test@example.com')

request( endpoint , **params )

Base method to generate requests for the Emailage validator and flagging APIs

Parameters

endpoint ( str ) API endpoint to send the request ( | /flag )
params ( kwargs ) keyword-argument list of parameters to send with the request

Returns

JSON dict of the response generated by the API

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('consumer_secret', 'consumer_token')
>>> response = client.request('/flag', email='user20180830001@domain20180830001.com', flag='good')
>>> response['query']['email']
u'user20180830001%40domain20180830001.com'

set_api_domain( domain , _tls_version= <SSLMethod.PROTOCOL_TLSv1_2: 5>)

Explicitly set the API domain to use for a session of the client, typically used in testing scenarios

Parameters

domain (str see :class: ApiDomains) API domain to use for the session
tls_version (see :class: TlsVersions) (Optional) Uses TLS version 1.2 by default (TlsVersions.TLSv1_2 | TlsVersions.TLSv1_1)

Returns

None

Example

>>> from emailage.client import EmailageClient
>>> from emailage.client import ApiDomains
>>> client = EmailageClient('consumer_secret', 'consumer_token')
>>> client.set_api_domain(ApiDomains.sandbox)
>>> client.domain
'https://sandbox.emailage.com'

Example

>>> from emailage.client import EmailageClient
>>> client = EmailageClient('consumer_secret', 'consumer_token')
>>> client.set_api_domain('https://testing.emailage.com')
>>> client.domain
'https://testing.emailage.com'

set_credentials( secret , token )

Explicitly set the authentication credentials to be used when generating a request in the current session. Useful when you want to change credentials after initial creation of the client.

Parameters

secret Consumer secret, e.g. SID or API key
token Consumer token

Returns

None

set_http_method( http_method )

Explicitly set the Http method (GET or POST) through which you will be sending the request. This method will be used for any future calls made with this instance of the client until another method is specified

Parameters

http_method (str see :class: HttpMethods) HttpMethod to use for sending requests

Returns

None

Example

>>> from emailage.client import EmailageClient, HttpMethods
>>> client = EmailageClient('consumer_secret', 'consumer_token')
>>> client.set_http_method(HttpMethods.POST)
>>> client.http_method
'POST'

class `emailage.client.ApiDomains`

API URLs for the specified domains

class `emailage.client.HttpMethods`

HttpMethod constants to pass to the client

class `emailage.client.TlsVersions`

An enumeration of the TLS versions supported by the Emailage API

module `emailage.signature`

`emailage.signature.create`( method , url , params , hmac_key )

Generates the OAuth1.0 signature used as the value for the query string parameter oauth_signature

Parameters

method ( str ) HTTP method that will be used to send the request ( GET | POST )
url ( str ) API domain and endpoint up to the ?
params ( dict ) user-provided query string parameters and the OAuth1.0 parameters :method add_oauth_entries_to_fields_dict:
hmac_key ( str ) for Emailage users, this is your consumer token with an & (ampersand) appended to the end

Returns

str value used for oauth_signature

Example

>>> from emailage.signature import add_oauth_entries_to_fields_dict, create
>>> your_api_key = 'SOME_KEY'
>>> your_hmac_key = 'SOME_SECRET' + '&'
>>> api_url = 'https://sandbox.emailage.com/emailagevalidator/'
>>> query_params = { 'query': 'user.you.are.validating@gmail.com', 'user_email': 'admin@yourcompany.com' }
>>> query_params = add_oauth_entries_to_fields_dict(your_api_key, query_params)
>>> query_params['oauth_signature'] = create('GET', api_url, query_params, your_hmac_key)

Revision History

1.2.2 (11 March 2020)

Fix POST requests for Python 2.7 users

1.2.1 (3 March 2020)

Remove mock dependency from requirements.txt

1.2.0 (10 January 2020)

HTTP verb for requests is a parameter to __init__, defaults to GET
Request timeout can be specified as parameter to __init__
UTF-8 characters may be sent via the POST request

1.1.6 (14 December 2018)

Fix choice of URL encoding function for Python 2.7 users

1.1.4 (17 September 2018)

Corrected IPv4 validation Regex to allow 0s in octets 2,3,4

1.1.0 (30 August 2018)

Corrected bug in the URL encoding of spaces
Significantly expanded documentation of signature functions
Extracted all OAuth signature generation logic from request generation into the signature module
Explicit decoding of API response bytes removes the need to run a Regex over the response

1.0.2 (30 October 2017)

Corrected the validation of IPv4 and IPv6 IP addresses
Added an optional parameter to specify TLS 1.1 or 1.2 on the initialization of EmailageClient

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

This version

1.2.2

Mar 11, 2020

1.2.1

Mar 5, 2020

1.2.0

Jan 10, 2020

1.1.8

Oct 10, 2019

1.1.7

Apr 12, 2019

1.1.6

Jan 18, 2019

1.1.5

Oct 15, 2018

1.1.4

Sep 18, 2018

1.1.3

Sep 7, 2018

1.1.2

Sep 7, 2018

1.1.1

Sep 7, 2018

1.1.0

Sep 7, 2018

1.0.3

Sep 6, 2018

1.0.2

Nov 7, 2017

1.0.1

Sep 30, 2016

1.0.0

Sep 23, 2016

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emailage-official-1.2.2.tar.gz (19.9 kB view details)

Uploaded Mar 11, 2020 Source

File details

Details for the file emailage-official-1.2.2.tar.gz.

File metadata

Download URL: emailage-official-1.2.2.tar.gz
Upload date: Mar 11, 2020
Size: 19.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.5.2

File hashes

Hashes for emailage-official-1.2.2.tar.gz
Algorithm	Hash digest
SHA256	`ee7b77201c9e73fc10318377a43de22fd4f12fbfd53718b6129a9f1ac7824447`
MD5	`dadee008fa8e0ccc723dc20e44447814`
BLAKE2b-256	`11fe0804d0a2129d1b7413fb9d018163063922a3169aefc5a811f6da17aae7ce`

See more details on using hashes here.

emailage-official 1.2.2

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Quickstart guide

Requirements

Installation

Typical usage

Instantiate a client

Targeting the production servers

Targeting the sandbox environment

Query risk score information for the provided email address, IP address,

Mark an email address as fraud, good, or neutral

Mark an email address as fraud because of Synthetic ID

Exceptions

Client API reference

module emailage.client

class emailage.client.EmailageClient( secret , token ,

class emailage.client.ApiDomains

class emailage.client.HttpMethods

class emailage.client.TlsVersions

module emailage.signature

emailage.signature.create( method , url , params , hmac_key )

Revision History

1.2.2 (11 March 2020)

1.2.1 (3 March 2020)

1.2.0 (10 January 2020)

1.1.6 (14 December 2018)

1.1.4 (17 September 2018)

1.1.0 (30 August 2018)

1.0.2 (30 October 2017)

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

File details

File metadata

File hashes

module `emailage.client`

class `emailage.client.EmailageClient`( secret , token ,

class `emailage.client.ApiDomains`

class `emailage.client.HttpMethods`

class `emailage.client.TlsVersions`

module `emailage.signature`

`emailage.signature.create`( method , url , params , hmac_key )