Plataforma13/Emailage_SDK_php

PHP SDK for Emailage API

(https://www.emailage.com)

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.

See our Example script for full code example.

Creating the Class

	include 'Emailage.class.php';
	
	$account_sid = 'My Account SID';
	$authToken = 'My Auth Token';
	
	$Emailage = new Emailage($account_sid, $authToken);

###Changing Settings.

#####Option 1, on Class Creation

	include 'Emailage.class.php';
	
	$account_sid = 'My Account SID';
	$authToken = 'My Auth Token';
	$sandbox = TRUE; // Do I connect to the Sandbox or FALSE for the live system
	$format = 'json'; // What format do I want returned ?  json or xml ?
	$signature_method = 'sha1'; // What Encrption Method do I want to use ? Alowed types ('sha1', 'sha256', 'sha384', 'sha512')
	$validate_response = TRUE; // Should the SDK Validate the response and throw an error if an error is found?
	$return_parsed_result = TRUE; // Do I want my results returned to me already formatted. I.E. Already turned into Simple XML Object or JSON Object ?
	
	$Emailage = new Emailage($account_sid, $authToken, $sandbox, $format, $signature_method, $validate_response, $return_parsed_result);

#####Option 2, after Class Creation

	include 'Emailage.class.php';
	
	$account_sid = 'My Account SID';
	$authToken = 'My Auth Token';
	
	$Emailage = new Emailage($account_sid, $authToken);
	$Emailage->changeSetting('format', 'json');
	$Emailage->changeSetting('signature_method', 'sha256');
	$Emailage->changeSetting('validate_response', FALSE);
	$Emailage->changeSetting('return_parsed_result', FALSE);

###Validating

By Email Address

	$Emailage->QueryEmail('example@example.com');

#####By IP

	$Emailage->QueryIpAddress('127.0.0.1');

#####By Both Email and IP

	$Emailage->QueryEmailAndIpAddress('example@example.com', '127.0.0.1');

###Adding a User Defined Record ID. ######This parameter can be used when you want to add an identifier for a query. The identifier will display in the result.

	$Emailage->QueryEmail('example@example.com', 1234);
	$Emailage->QueryIpAddress('127.0.0.1', 1235);
	$Emailage->QueryEmailAndIpAddress('example@example.com', '127.0.0.1', 1236);

###Flagging an Email Address

#####As Fraud

	/**
		The fraudcodeID is ONLY required when the flag is "fraud". Possible values are:
		1 Card Not Present Fraud
		2 Customer Dispute (Chargeback)
		3 First Party Fraud
		4 First Payment Default
		5 Identify Theft (Fraud Application) 
		6 Identify Theft (Account Take Over) 
		7 Suspected Fraud (Not Confirmed) 
		8 Synthetic ID
		9 Other
	*/
	$fraudID = 9;
	$Emailage->FlagEmailAsFraud('example@example.com', $fraudID);

#####As Neutral

	$Emailage->RemoveFlagFromEmail('example@example.com');

#####As Good

	$Emailage->FlagEmailAsGood('example@example.com');

###Errors

This SDK will throw errors when any of the following issues occur, make sure your scripts catch the exceptions.

1. When you set a setting to an invalid format.
2. When Curl has an issue, like not being able to connect from your server to Emailge API.
3. When bad formated XML is received
4. When bad formatted JSON is received
5. If you have validate_response == TRUE, and an error is returned by Emailage, an error will be thrown