Getting started

The general-purpose API

How to Build

The generated code uses a few Maven dependencies e.g., Jackson, UniRest, and Apache HttpClient. The reference to these dependencies is already added in the pom.xml file will be installed automatically. Therefore, you will need internet access for a successful build.

In order to open the client library in Eclipse click on File -> Import.

In the import dialog, select Existing Java Project and click Next.

Browse to locate the folder containing the source code. Select the detected location of the project and click Finish.

Upon successful import, the project will be automatically built by Eclipse after automatically resolving the dependencies.

How to Use

The following section explains how to use the NeutrinoAPI library in a new console project.

1. Starting a new project

For starting a new project, click the menu command File > New > Project.

Next, choose Maven > Maven Projectand click Next.

Here, make sure to use the current workspace by choosing Use default Workspace location, as shown in the picture below and click Next.

Following this, select the quick start project type to create a simple project with an existing class and a main method. To do this, choose maven-archetype-quickstart item from the list and click Next.

In the last step, provide a Group Id and Artifact Id as shown in the picture below and click Finish.

2. Add reference of the library project

The created Maven project manages its dependencies using its pom.xml file. In order to add a dependency on the NeutrinoAPI client library, double click on the pom.xml file in the Package Explorer. Opening the pom.xml file will render a graphical view on the cavas. Here, switch to the Dependencies tab and click the Add button as shown in the picture below.

Clicking the Add button will open a dialog where you need to specify NeutrinoAPI in Group Id and NeutrinoAPI in the Artifact Id fields. Once added click OK. Save the pom.xml file.

3. Write sample code

Once the SimpleConsoleApp is created, a file named App.java will be visible in the Package Explorer with a main method. This is the entry point for the execution of the created project. Here, you can add code to initialize the client library and instantiate a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

How to Test

The generated code and the server can be tested using automatically generated test cases. JUnit is used as the testing framework and test runner.

In Eclipse, for running the tests do the following:

Select the project NeutrinoAPI from the package explorer.
Select "Run -> Run as -> JUnit Test" or use "Alt + Shift + X" followed by "T" to run the Tests.

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter	Description
userId	Your user ID
apiKey	Your API key

API client can be initialized as following.

// Configuration parameters and credentials
String userId = "userId"; // Your user ID
String apiKey = "apiKey"; // Your API key

NeutrinoAPIClient client = new NeutrinoAPIClient(userId, apiKey);

Class Reference

WWW

Get singleton instance

The singleton instance of the WWW class can be accessed from the API Client.

WWW wWW = client.getWWW();

browserBotAsync

Browser bot can extract content, interact with keyboard and mouse events, and execute JavaScript on a website. See: https://www.neutrinoapi.com/api/browser-bot/

void browserBotAsync(
        final String url,
        final Integer timeout,
        final Integer delay,
        final String selector,
        final List<String> exec,
        final String userAgent,
        final Boolean ignoreCertificateErrors,
        final APICallBack<BrowserBotResponse> callBack)

Parameters

Parameter	Tags	Description
url	`Required`	The URL to load
timeout	`Optional` `DefaultValue`	Timeout in seconds. Give up if still trying to load the page after this number of seconds
delay	`Optional` `DefaultValue`	Delay in seconds to wait before executing any selectors or JavaScript
selector	`Optional`	Extract content from the page DOM using this selector. Commonly known as a CSS selector, you can find a good reference here
exec	`Optional` `Collection` `DefaultValue`	Execute JavaScript on the page. Each array element should contain a valid JavaScript statement in string form. If a statement returns any kind of value it will be returned in the 'exec-results' response. For your convenience you can also use the following special shortcut functions: sleep(seconds); Just wait/sleep for the specified number of seconds. click('selector'); Click on the first element matching the given selector. focus('selector'); Focus on the first element matching the given selector. keys('characters'); Send the specified keyboard characters. Use click() or focus() first to send keys to a specific element. enter(); Send the Enter key. tab(); Send the Tab key. Example: [ "click('#button-id')", "sleep(1)", "click('.field-class')", "keys('1234')", "enter()" ]
userAgent	`Optional`	Override the browsers default user-agent string with this one
ignoreCertificateErrors	`Optional` `DefaultValue`	Ignore any TLS/SSL certificate errors and load the page anyway

Example Usage

String url = "url";
Integer timeout = 30;
Integer delay = 2;
String selector = "selector";
String execValue = "[]";
List<String> exec = mapper.readValue(execValue,new TypeReference<List<String>> (){});
String userAgent = "user-agent";
Boolean ignoreCertificateErrors = false;
// Invoking the API call with sample inputs
wWW.browserBotAsync(url, timeout, delay, selector, exec, userAgent, ignoreCertificateErrors, new APICallBack<BrowserBotResponse>() {
    public void onSuccess(HttpContext context, BrowserBotResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

hTMLCleanAsync

Clean and sanitize untrusted HTML. See: https://www.neutrinoapi.com/api/html-clean/

void hTMLCleanAsync(
        final String content,
        final String outputType,
        final APICallBack<InputStream> callBack)

Parameters

Parameter	Tags	Description
content	`Required`	The HTML content. This can be either a URL to load HTML from or an actual HTML content string
outputType	`Required`	The level of sanitization, possible values are: plain-text: reduce the content to plain text only (no HTML tags at all) simple-text: allow only very basic text formatting tags like b, em, i, strong, u basic-html: allow advanced text formatting and hyper links basic-html-with-images: same as basic html but also allows image tags advanced-html: same as basic html with images but also allows many more common HTML tags like table, ul, dl, pre

Example Usage

String content = "content";
String outputType = "output-type";
// Invoking the API call with sample inputs
wWW.hTMLCleanAsync(content, outputType, new APICallBack<InputStream>() {
    public void onSuccess(HttpContext context, InputStream response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

uRLInfoAsync

Parse, analyze and retrieve content from the supplied URL. See: https://www.neutrinoapi.com/api/url-info/

void uRLInfoAsync(
        final String url,
        final Boolean fetchContent,
        final APICallBack<URLInfoResponse> callBack)

Parameters

Parameter	Tags	Description
url	`Required`	The URL to probe
fetchContent	`Optional` `DefaultValue`	If this URL responds with html, text, json or xml then return the response. This option is useful if you want to perform further processing on the URL content (e.g. with the HTML Extract or HTML Clean APIs)

Example Usage

String url = "url";
Boolean fetchContent = false;
// Invoking the API call with sample inputs
wWW.uRLInfoAsync(url, fetchContent, new APICallBack<URLInfoResponse>() {
    public void onSuccess(HttpContext context, URLInfoResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

Back to List of Controllers

Imaging

Get singleton instance

The singleton instance of the Imaging class can be accessed from the API Client.

Imaging imaging = client.getImaging();

imageWatermarkAsync

Watermark one image with another image. See: https://www.neutrinoapi.com/api/image-watermark/

void imageWatermarkAsync(
        final String imageUrl,
        final String watermarkUrl,
        final Integer opacity,
        final String format,
        final String position,
        final Integer width,
        final Integer height,
        final APICallBack<InputStream> callBack)

Parameters

Parameter	Tags	Description
imageUrl	`Required`	The URL to the source image
watermarkUrl	`Required`	The URL to the watermark image
opacity	`Optional` `DefaultValue`	The opacity of the watermark (0 to 100)
format	`Optional` `DefaultValue`	The output image format, can be either png or jpg
position	`Optional` `DefaultValue`	The position of the watermark image, possible values are: center, top-left, top-center, top-right, bottom-left, bottom-center, bottom-right
width	`Optional`	If set resize the resulting image to this width (in px) while preserving aspect ratio
height	`Optional`	If set resize the resulting image to this height (in px) while preserving aspect ratio

Example Usage

String imageUrl = "image-url";
String watermarkUrl = "watermark-url";
Integer opacity = 50;
String format = "png";
String position = "center";
Integer width = 112;
Integer height = 112;
// Invoking the API call with sample inputs
imaging.imageWatermarkAsync(imageUrl, watermarkUrl, opacity, format, position, width, height, new APICallBack<InputStream>() {
    public void onSuccess(HttpContext context, InputStream response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

qRCodeAsync

Generate a QR code as a PNG image. See: https://www.neutrinoapi.com/api/qr-code/

void qRCodeAsync(
        final String content,
        final Integer width,
        final Integer height,
        final String fgColor,
        final String bgColor,
        final APICallBack<InputStream> callBack)

Parameters

Parameter	Tags	Description
content	`Required`	The content to encode into the QR code (e.g. a URL or a phone number)
width	`Optional` `DefaultValue`	The width of the QR code (in px)
height	`Optional` `DefaultValue`	The height of the QR code (in px)
fgColor	`Optional` `DefaultValue`	The QR code foreground color
bgColor	`Optional` `DefaultValue`	The QR code background color

Example Usage

String content = "content";
Integer width = 256;
Integer height = 256;
String fgColor = "#000000";
String bgColor = "#ffffff";
// Invoking the API call with sample inputs
imaging.qRCodeAsync(content, width, height, fgColor, bgColor, new APICallBack<InputStream>() {
    public void onSuccess(HttpContext context, InputStream response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

imageResizeAsync

Resize an image and output as either JPEG or PNG. See: https://www.neutrinoapi.com/api/image-resize/

void imageResizeAsync(
        final String imageUrl,
        final int width,
        final int height,
        final String format,
        final APICallBack<InputStream> callBack)

Parameters

Parameter	Tags	Description
imageUrl	`Required`	The URL to the source image
width	`Required`	The width to resize to (in px) while preserving aspect ratio
height	`Required`	The height to resize to (in px) while preserving aspect ratio
format	`Optional` `DefaultValue`	The output image format, can be either png or jpg

Example Usage

String imageUrl = "image-url";
int width = 112;
int height = 112;
String format = "png";
// Invoking the API call with sample inputs
imaging.imageResizeAsync(imageUrl, width, height, format, new APICallBack<InputStream>() {
    public void onSuccess(HttpContext context, InputStream response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

hTML5RenderAsync

Render HTML content to PDF, JPG or PNG. See: https://www.neutrinoapi.com/api/html5-render/

void hTML5RenderAsync(
        final String content,
        final String format,
        final String pageSize,
        final String title,
        final Integer margin,
        final Integer marginLeft,
        final Integer marginRight,
        final Integer marginTop,
        final Integer marginBottom,
        final Boolean landscape,
        final Double zoom,
        final Boolean grayscale,
        final Boolean mediaPrint,
        final Boolean mediaQueries,
        final Boolean forms,
        final String css,
        final Integer imageWidth,
        final Integer imageHeight,
        final Integer renderDelay,
        final String headerTextLeft,
        final String headerTextCenter,
        final String headerTextRight,
        final Integer headerSize,
        final String headerFont,
        final Integer headerFontSize,
        final Boolean headerLine,
        final String footerTextLeft,
        final String footerTextCenter,
        final String footerTextRight,
        final Integer footerSize,
        final String footerFont,
        final Integer footerFontSize,
        final Boolean footerLine,
        final Integer pageWidth,
        final Integer pageHeight,
        final APICallBack<InputStream> callBack)

Parameters

Parameter	Tags	Description
content	`Required`	The HTML content. This can be either a URL to load HTML from or an actual HTML content string
format	`Optional` `DefaultValue`	Which format to output, available options are: PDF, PNG, JPG
pageSize	`Optional` `DefaultValue`	Set the document page size, can be one of: A0 - A9, B0 - B10, Comm10E, DLE or Letter
title	`Optional`	The document title
margin	`Optional` `DefaultValue`	The document margin (in mm)
marginLeft	`Optional` `DefaultValue`	The document left margin (in mm)
marginRight	`Optional` `DefaultValue`	The document right margin (in mm)
marginTop	`Optional` `DefaultValue`	The document top margin (in mm)
marginBottom	`Optional` `DefaultValue`	The document bottom margin (in mm)
landscape	`Optional` `DefaultValue`	Set the document to lanscape orientation
zoom	`Optional` `DefaultValue`	Set the zoom factor when rendering the page (2.0 for double size, 0.5 for half size)
grayscale	`Optional` `DefaultValue`	Render the final document in grayscale
mediaPrint	`Optional` `DefaultValue`	Use @media print CSS styles to render the document
mediaQueries	`Optional` `DefaultValue`	Activate all @media queries before rendering. This can be useful if you wan't to render the mobile version of a responsive website
forms	`Optional` `DefaultValue`	Generate real (fillable) PDF forms from HTML forms
css	`Optional`	Inject custom CSS into the HTML. e.g. 'body { background-color: red;}'
imageWidth	`Optional` `DefaultValue`	If rendering to an image format (PNG or JPG) use this image width (in pixels)
imageHeight	`Optional`	If rendering to an image format (PNG or JPG) use this image height (in pixels). The default is automatic which dynamically sets the image height based on the content
renderDelay	`Optional` `DefaultValue`	Number of milliseconds to wait before rendering the page (can be useful for pages with animations etc)
headerTextLeft	`Optional`	Text to print to the left-hand side header of each page. e.g. 'My header - Page {page_number} of {total_pages}'
headerTextCenter	`Optional`	Text to print to the center header of each page
headerTextRight	`Optional`	Text to print to the right-hand side header of each page
headerSize	`Optional` `DefaultValue`	The height of your header (in mm)
headerFont	`Optional` `DefaultValue`	Set the header font. Fonts available: Times, Courier, Helvetica, Arial
headerFontSize	`Optional` `DefaultValue`	Set the header font size (in pt)
headerLine	`Optional` `DefaultValue`	Draw a full page width horizontal line under your header
footerTextLeft	`Optional`	Text to print to the left-hand side footer of each page. e.g. 'My footer - Page {page_number} of {total_pages}'
footerTextCenter	`Optional`	Text to print to the center header of each page
footerTextRight	`Optional`	Text to print to the right-hand side header of each page
footerSize	`Optional` `DefaultValue`	The height of your footer (in mm)
footerFont	`Optional` `DefaultValue`	Set the footer font. Fonts available: Times, Courier, Helvetica, Arial
footerFontSize	`Optional` `DefaultValue`	Set the footer font size (in pt)
footerLine	`Optional` `DefaultValue`	Draw a full page width horizontal line above your footer
pageWidth	`Optional`	Set the PDF page width explicitly (in mm)
pageHeight	`Optional`	Set the PDF page height explicitly (in mm)

Example Usage

String content = "content";
String format = "PDF";
String pageSize = "A4";
String title = "title";
Integer margin = 0;
Integer marginLeft = 0;
Integer marginRight = 0;
Integer marginTop = 0;
Integer marginBottom = 0;
Boolean landscape = false;
Double zoom = 1;
Boolean grayscale = false;
Boolean mediaPrint = false;
Boolean mediaQueries = false;
Boolean forms = false;
String css = "css";
Integer imageWidth = 1024;
Integer imageHeight = 112;
Integer renderDelay = 0;
String headerTextLeft = "header-text-left";
String headerTextCenter = "header-text-center";
String headerTextRight = "header-text-right";
Integer headerSize = 9;
String headerFont = "Courier";
Integer headerFontSize = 11;
Boolean headerLine = false;
String footerTextLeft = "footer-text-left";
String footerTextCenter = "footer-text-center";
String footerTextRight = "footer-text-right";
Integer footerSize = 9;
String footerFont = "Courier";
Integer footerFontSize = 11;
Boolean footerLine = false;
Integer pageWidth = 112;
Integer pageHeight = 112;
// Invoking the API call with sample inputs
imaging.hTML5RenderAsync(content, format, pageSize, title, margin, marginLeft, marginRight, marginTop, marginBottom, landscape, zoom, grayscale, mediaPrint, mediaQueries, forms, css, imageWidth, imageHeight, renderDelay, headerTextLeft, headerTextCenter, headerTextRight, headerSize, headerFont, headerFontSize, headerLine, footerTextLeft, footerTextCenter, footerTextRight, footerSize, footerFont, footerFontSize, footerLine, pageWidth, pageHeight, new APICallBack<InputStream>() {
    public void onSuccess(HttpContext context, InputStream response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

Back to List of Controllers

Telephony

Get singleton instance

The singleton instance of the Telephony class can be accessed from the API Client.

Telephony telephony = client.getTelephony();

phoneVerifyAsync

Make an automated call to any valid phone number and playback a unique security code. See: https://www.neutrinoapi.com/api/phone-verify/

void phoneVerifyAsync(
        final String number,
        final Integer codeLength,
        final Integer securityCode,
        final Integer playbackDelay,
        final String countryCode,
        final String languageCode,
        final APICallBack<PhoneVerifyResponse> callBack)

Parameters

Parameter	Tags	Description
number	`Required`	The phone number to send the verification code to
codeLength	`Optional` `DefaultValue`	The number of digits to use in the security code (between 4 and 12)
securityCode	`Optional`	Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code
playbackDelay	`Optional` `DefaultValue`	The delay in milliseconds between the playback of each security code
countryCode	`Optional`	ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
languageCode	`Optional` `DefaultValue`	The language to playback the verification code in, available languages are: de - German en - English es - Spanish fr - French it - Italian pt - Portuguese ru - Russian

Example Usage

String number = "number";
Integer codeLength = 6;
Integer securityCode = 112;
Integer playbackDelay = 800;
String countryCode = "country-code";
String languageCode = "en";
// Invoking the API call with sample inputs
telephony.phoneVerifyAsync(number, codeLength, securityCode, playbackDelay, countryCode, languageCode, new APICallBack<PhoneVerifyResponse>() {
    public void onSuccess(HttpContext context, PhoneVerifyResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

sMSMessageAsync

Send a free-form message to any mobile device via SMS. See: https://www.neutrinoapi.com/api/sms-message/

void sMSMessageAsync(
        final String number,
        final String message,
        final String countryCode,
        final APICallBack<SMSMessageResponse> callBack)

Parameters

Parameter	Tags	Description
number	`Required`	The phone number to send a message to
message	`Required`	The SMS message to send. Messages are truncated to a maximum of 150 characters for ASCII content OR 70 characters for UTF content
countryCode	`Optional`	ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)

Example Usage

String number = "number";
String message = "message";
String countryCode = "country-code";
// Invoking the API call with sample inputs
telephony.sMSMessageAsync(number, message, countryCode, new APICallBack<SMSMessageResponse>() {
    public void onSuccess(HttpContext context, SMSMessageResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

sMSVerifyAsync

Send a unique security code to any mobile device via SMS. See: https://www.neutrinoapi.com/api/sms-verify/

void sMSVerifyAsync(
        final String number,
        final Integer codeLength,
        final Integer securityCode,
        final String countryCode,
        final String languageCode,
        final APICallBack<SMSVerifyResponse> callBack)

Parameters

Parameter	Tags	Description
number	`Required`	The phone number to send a verification code to
codeLength	`Optional` `DefaultValue`	The number of digits to use in the security code (must be between 4 and 12)
securityCode	`Optional`	Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code
countryCode	`Optional`	ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
languageCode	`Optional` `DefaultValue`	The language to send the verification code in, available languages are: de - German en - English es - Spanish fr - French it - Italian pt - Portuguese ru - Russian

Example Usage

String number = "number";
Integer codeLength = 5;
Integer securityCode = 112;
String countryCode = "country-code";
String languageCode = "en";
// Invoking the API call with sample inputs
telephony.sMSVerifyAsync(number, codeLength, securityCode, countryCode, languageCode, new APICallBack<SMSVerifyResponse>() {
    public void onSuccess(HttpContext context, SMSVerifyResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

verifySecurityCodeAsync

Check if a security code from one of the verify APIs is valid. See: https://www.neutrinoapi.com/api/verify-security-code/

void verifySecurityCodeAsync(
        final String securityCode,
        final APICallBack<VerifySecurityCodeResponse> callBack)

Parameters

Parameter	Tags	Description
securityCode	`Required`	The security code to verify

Example Usage

String securityCode = "security-code";
// Invoking the API call with sample inputs
telephony.verifySecurityCodeAsync(securityCode, new APICallBack<VerifySecurityCodeResponse>() {
    public void onSuccess(HttpContext context, VerifySecurityCodeResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

phonePlaybackAsync

Make an automated call to any valid phone number and playback an audio message. See: https://www.neutrinoapi.com/api/phone-playback/

void phonePlaybackAsync(
        final String number,
        final String audioUrl,
        final APICallBack<PhonePlaybackResponse> callBack)

Parameters

Parameter	Tags	Description
number	`Required`	The phone number to call. Must be in valid international format
audioUrl	`Required`	A URL to a valid audio file. Accepted audio formats are: MP3 WAV OGG You can use the following MP3 URL for testing: https://www.neutrinoapi.com/test-files/test1.mp3

Example Usage

String number = "number";
String audioUrl = "audio-url";
// Invoking the API call with sample inputs
telephony.phonePlaybackAsync(number, audioUrl, new APICallBack<PhonePlaybackResponse>() {
    public void onSuccess(HttpContext context, PhonePlaybackResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

hLRLookupAsync

Connect to the global mobile cellular network and retrieve the status of a mobile device. See: https://www.neutrinoapi.com/api/hlr-lookup/

void hLRLookupAsync(
        final String number,
        final String countryCode,
        final APICallBack<HLRLookupResponse> callBack)

Parameters

Parameter	Tags	Description
number	`Required`	A phone number
countryCode	`Optional`	ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)

Example Usage

String number = "number";
String countryCode = "country-code";
// Invoking the API call with sample inputs
telephony.hLRLookupAsync(number, countryCode, new APICallBack<HLRLookupResponse>() {
    public void onSuccess(HttpContext context, HLRLookupResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

Back to List of Controllers

ECommerce

Get singleton instance

The singleton instance of the ECommerce class can be accessed from the API Client.

ECommerce eCommerce = client.getECommerce();

bINLookupAsync

Perform a BIN (Bank Identification Number) or IIN (Issuer Identification Number) lookup. See: https://www.neutrinoapi.com/api/bin-lookup/

void bINLookupAsync(
        final String binNumber,
        final String customerIp,
        final APICallBack<BINLookupResponse> callBack)

Parameters

Parameter	Tags	Description
binNumber	`Required`	The BIN or IIN number (the first 6 digits of a credit card number)
customerIp	`Optional`	Pass in the customers IP address and we will return some extra information about them

Example Usage

String binNumber = "bin-number";
String customerIp = "customer-ip";
// Invoking the API call with sample inputs
eCommerce.bINLookupAsync(binNumber, customerIp, new APICallBack<BINLookupResponse>() {
    public void onSuccess(HttpContext context, BINLookupResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

Back to List of Controllers

Geolocation

Get singleton instance

The singleton instance of the Geolocation class can be accessed from the API Client.

Geolocation geolocation = client.getGeolocation();

geocodeAddressAsync

Geocode an address, partial address or just the name of a place. See: https://www.neutrinoapi.com/api/geocode-address/

void geocodeAddressAsync(
        final String address,
        final String countryCode,
        final String languageCode,
        final Boolean fuzzySearch,
        final APICallBack<GeocodeAddressResponse> callBack)

Parameters

Parameter	Tags	Description
address	`Required`	The address, partial address or name of a place to try and locate
countryCode	`Optional`	The ISO 2-letter country code to be biased towards (the default is no country bias)
languageCode	`Optional` `DefaultValue`	The language to display results in, available languages are: de, en, es, fr, it, pt, ru
fuzzySearch	`Optional` `DefaultValue`	If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. We use a combination of approximate string matching and data cleansing to find possible location matches

Example Usage

String address = "address";
String countryCode = "country-code";
String languageCode = "en";
Boolean fuzzySearch = false;
// Invoking the API call with sample inputs
geolocation.geocodeAddressAsync(address, countryCode, languageCode, fuzzySearch, new APICallBack<GeocodeAddressResponse>() {
    public void onSuccess(HttpContext context, GeocodeAddressResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

iPInfoAsync

Get location information about an IP address and do reverse DNS (PTR) lookups. See: https://www.neutrinoapi.com/api/ip-info/

void iPInfoAsync(
        final String ip,
        final Boolean reverseLookup,
        final APICallBack<IPInfoResponse> callBack)

Parameters

Parameter	Tags	Description
ip	`Required`	IPv4 or IPv6 address
reverseLookup	`Optional` `DefaultValue`	Do a reverse DNS (PTR) lookup. This option can add extra delay to the request so only use it if you need it

Example Usage

String ip = "ip";
Boolean reverseLookup = false;
// Invoking the API call with sample inputs
geolocation.iPInfoAsync(ip, reverseLookup, new APICallBack<IPInfoResponse>() {
    public void onSuccess(HttpContext context, IPInfoResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

geocodeReverseAsync

Convert a geographic coordinate (latitude and longitude) into a real world address or location. See: https://www.neutrinoapi.com/api/geocode-reverse/

void geocodeReverseAsync(
        final String latitude,
        final String longitude,
        final String languageCode,
        final APICallBack<GeocodeReverseResponse> callBack)

Parameters

Parameter	Tags	Description
latitude	`Required`	The location latitude in decimal degrees format
longitude	`Required`	The location longitude in decimal degrees format
languageCode	`Optional` `DefaultValue`	The language to display results in, available languages are: de, en, es, fr, it, pt, ru

Example Usage

String latitude = "latitude";
String longitude = "longitude";
String languageCode = "en";
// Invoking the API call with sample inputs
geolocation.geocodeReverseAsync(latitude, longitude, languageCode, new APICallBack<GeocodeReverseResponse>() {
    public void onSuccess(HttpContext context, GeocodeReverseResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

Back to List of Controllers

SecurityAndNetworking

Get singleton instance

The singleton instance of the SecurityAndNetworking class can be accessed from the API Client.

SecurityAndNetworking securityAndNetworking = client.getSecurityAndNetworking();

iPBlocklistAsync

The IP Blocklist API will detect potentially malicious or dangerous IP addresses. See: https://www.neutrinoapi.com/api/ip-blocklist/

void iPBlocklistAsync(
        final String ip,
        final APICallBack<IPBlocklistResponse> callBack)

Parameters

Parameter	Tags	Description
ip	`Required`	An IPv4 or IPv6 address

Example Usage

String ip = "ip";
// Invoking the API call with sample inputs
securityAndNetworking.iPBlocklistAsync(ip, new APICallBack<IPBlocklistResponse>() {
    public void onSuccess(HttpContext context, IPBlocklistResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

emailVerifyAsync

SMTP based email address verification. See: https://www.neutrinoapi.com/api/email-verify/

void emailVerifyAsync(
        final String email,
        final Boolean fixTypos,
        final APICallBack<EmailVerifyResponse> callBack)

Parameters

Parameter	Tags	Description
email	`Required`	An email address
fixTypos	`Optional` `DefaultValue`	Automatically attempt to fix typos in the address

Example Usage

String email = "email";
Boolean fixTypos = false;
// Invoking the API call with sample inputs
securityAndNetworking.emailVerifyAsync(email, fixTypos, new APICallBack<EmailVerifyResponse>() {
    public void onSuccess(HttpContext context, EmailVerifyResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

hostReputationAsync

Check the reputation of an IP address, domain name, FQDN or URL against a comprehensive list of blacklists and blocklists. See: https://www.neutrinoapi.com/api/host-reputation/

void hostReputationAsync(
        final String host,
        final Integer listRating,
        final APICallBack<HostReputationResponse> callBack)

Parameters

Parameter	Tags	Description
host	`Required`	An IP address, domain name, FQDN or URL. If you supply a domain/URL it will be checked against the URI DNSBL lists
listRating	`Optional` `DefaultValue`	Only check lists with this rating or better

Example Usage

String host = "host";
Integer listRating = 3;
// Invoking the API call with sample inputs
securityAndNetworking.hostReputationAsync(host, listRating, new APICallBack<HostReputationResponse>() {
    public void onSuccess(HttpContext context, HostReputationResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

iPProbeAsync

Analyze and extract provider information for an IP address. See: https://www.neutrinoapi.com/api/ip-probe/

void iPProbeAsync(
        final String ip,
        final APICallBack<IPProbeResponse> callBack)

Parameters

Parameter	Tags	Description
ip	`Required`	IPv4 or IPv6 address

Example Usage

String ip = "ip";
// Invoking the API call with sample inputs
securityAndNetworking.iPProbeAsync(ip, new APICallBack<IPProbeResponse>() {
    public void onSuccess(HttpContext context, IPProbeResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

Back to List of Controllers

DataTools

Get singleton instance

The singleton instance of the DataTools class can be accessed from the API Client.

DataTools dataTools = client.getDataTools();

userAgentInfoAsync

Parse, validate and get detailed user-agent information from a user agent string. See: https://www.neutrinoapi.com/api/user-agent-info/

void userAgentInfoAsync(
        final String userAgent,
        final APICallBack<UserAgentInfoResponse> callBack)

Parameters

Parameter	Tags	Description
userAgent	`Required`	A user agent string

Example Usage

String userAgent = "user-agent";
// Invoking the API call with sample inputs
dataTools.userAgentInfoAsync(userAgent, new APICallBack<UserAgentInfoResponse>() {
    public void onSuccess(HttpContext context, UserAgentInfoResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

phoneValidateAsync

Parse, validate and get location information about a phone number. See: https://www.neutrinoapi.com/api/phone-validate/

void phoneValidateAsync(
        final String number,
        final String countryCode,
        final String ip,
        final APICallBack<PhoneValidateResponse> callBack)

Parameters

Parameter	Tags	Description
number	`Required`	A phone number. This can be in international format (E.164) or local format. If passing local format you should use the 'country-code' or 'ip' options as well
countryCode	`Optional`	ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
ip	`Optional`	Pass in a users IP address and we will assume numbers are based in the country of the IP address

Example Usage

String number = "number";
String countryCode = "country-code";
String ip = "ip";
// Invoking the API call with sample inputs
dataTools.phoneValidateAsync(number, countryCode, ip, new APICallBack<PhoneValidateResponse>() {
    public void onSuccess(HttpContext context, PhoneValidateResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

convertAsync

A powerful unit conversion tool. See: https://www.neutrinoapi.com/api/convert/

void convertAsync(
        final String fromValue,
        final String fromType,
        final String toType,
        final APICallBack<ConvertResponse> callBack)

Parameters

Parameter	Tags	Description
fromValue	`Required`	The value to convert from (e.g. 10.95)
fromType	`Required`	The type of the value to convert from (e.g. USD)
toType	`Required`	The type to convert to (e.g. EUR)

Example Usage

String fromValue = "from-value";
String fromType = "from-type";
String toType = "to-type";
// Invoking the API call with sample inputs
dataTools.convertAsync(fromValue, fromType, toType, new APICallBack<ConvertResponse>() {
    public void onSuccess(HttpContext context, ConvertResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

badWordFilterAsync

Detect bad words, swear words and profanity in a given text. See: https://www.neutrinoapi.com/api/bad-word-filter/

void badWordFilterAsync(
        final String content,
        final String censorCharacter,
        final APICallBack<BadWordFilterResponse> callBack)

Parameters

Parameter	Tags	Description
content	`Required`	The content to scan. This can be either a URL to load content from or an actual content string
censorCharacter	`Optional`	The character to use to censor out the bad words found

Example Usage

String content = "content";
String censorCharacter = "censor-character";
// Invoking the API call with sample inputs
dataTools.badWordFilterAsync(content, censorCharacter, new APICallBack<BadWordFilterResponse>() {
    public void onSuccess(HttpContext context, BadWordFilterResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

emailValidateAsync

Parse, validate and clean an email address. See: https://www.neutrinoapi.com/api/email-validate/

void emailValidateAsync(
        final String email,
        final Boolean fixTypos,
        final APICallBack<EmailValidateResponse> callBack)

Parameters

Parameter	Tags	Description
email	`Required`	An email address
fixTypos	`Optional` `DefaultValue`	Automatically attempt to fix typos in the address

Example Usage

String email = "email";
Boolean fixTypos = false;
// Invoking the API call with sample inputs
dataTools.emailValidateAsync(email, fixTypos, new APICallBack<EmailValidateResponse>() {
    public void onSuccess(HttpContext context, EmailValidateResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});

Back to List of Controllers

Name		Name	Last commit message	Last commit date
Latest commit History 9 Commits
.settings		.settings
src/main/java/com/neutrinoapi/sdk		src/main/java/com/neutrinoapi/sdk
.classpath		.classpath
.project		.project
LICENSE		LICENSE
README.md		README.md
pom.xml		pom.xml

License

hoikin/NeutrinoAPI-Java

Folders and files

Latest commit

History

Repository files navigation

Getting started

How to Build

How to Use

1. Starting a new project

2. Add reference of the library project

3. Write sample code

How to Test

Initialization

Authentication

Class Reference

List of Controllers

WWW

Get singleton instance

browserBotAsync

Parameters

Example Usage

hTMLCleanAsync

Parameters

Example Usage

uRLInfoAsync

Parameters

Example Usage

Imaging

Get singleton instance

imageWatermarkAsync

Parameters

Example Usage

qRCodeAsync

Parameters

Example Usage

imageResizeAsync

Parameters

Example Usage

hTML5RenderAsync

Parameters

Example Usage

Telephony

Get singleton instance

phoneVerifyAsync

Parameters

Example Usage

sMSMessageAsync

Parameters

Example Usage

sMSVerifyAsync

Parameters

Example Usage

verifySecurityCodeAsync

Parameters

Example Usage

phonePlaybackAsync

Parameters

Example Usage

hLRLookupAsync

Parameters

Example Usage

ECommerce

Get singleton instance

bINLookupAsync

Parameters

Example Usage

Geolocation

Get singleton instance

geocodeAddressAsync

Parameters

Example Usage

iPInfoAsync

Parameters

Example Usage

geocodeReverseAsync

Parameters

Example Usage

SecurityAndNetworking

Get singleton instance

Packages