REGISTER FOR A KEY
In order to use the RESTful api you have to obtain a api key. Obtaining a api key is free and can be done in just a few seconds. Click here to be taken to the api key form.
DOWNLOAD
Download the php client to use in your server side scripts and the css to style the way DEAFilter will interact with your own website.
You can use it as is or modify the css and images to fit your style.
USAGE
Download the package:
It contains an Images folder containing just a couple of icons to use in your client side validation. Feel free to move them or change them to fit your style.
You will find also a file called deaFilter.css which is a style sheet definition file which defines 4 classes:
- DeaFilterValid
- DeaFilterInvalid
- DeaValidIconDiv
- DeaInvalidIconDiv
The first two will apply to the email input text field, you can leave them as they are or change them to reflect your style.
The latter ones are related to the icons that will appear next to the email input text field. Also as before you can leave it as it is or modify it to reflect your own style.
Import the script into your page:
Just copy and paste the following snippet before your closing body tag:
<!-- start of DeaFilter block -->
<script type="text/javascript">
/**
* here you can set some configuration parameters
*/
var emailFieldId = "email"; //the id attribute of the input text field which contains the email address
var waitForCheck = true; //waits to issue the call to the RESTful api for the email text field to contain a @ and a subsequent dot char
var useDeaIcon = true; //if set to true a little icon will show next to the field indicating the validation state (check the deaFilter.css for personalization possibilities)
var deaFilterApiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; //your application key
</script>
<script type="text/javascript" src="http://www.deafilter.com/widget/deaFilterClient.js"></script>
<!-- end of DeaFilter block -->
Hey don't forget to fill in the deaFilterApiKey with the key you obtained from us!!
Executing server side validation:
In the package you downloaded you will find a file called DeaTest.php.
Inside you will discover how easy is to implement DEAFilter as a server side validation component.
Just include the DeaFilter php client script and the call the validation function...
include 'deaFilterClient.php';
if(checkDEAfilter($_REQUEST["email"],"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")){ //pass your apikey as second parameter
echo "valid!";
}else{
echo "not valid!!";
}
Easy uh?
The little demo:
The file test.html will show you how to get it all up and working. It has the client side validation implemented and will point to a script with a neat implementation of the server side validation.
Having it up and going will not require more than five minutes. Thats it!
CREDITS
DEAFilter was made by Thorfinio with the advice of some friends in looong boring afternoon....
If you find this service useful please take time to make a voluntary donation, we will use it to pay our hosting bills!
LICENCE
DEAFilter is distributed under the terms of the Gnu GPLv3 licence. You can read all the details here:
GNU General Public License
CONTACTS
Having some advice, insult or proposal for me? mail me at info@deafilter.com.