Client Libraries


We provide software libraries to make your integration of the Optimaize PII Platform APIs into your software as smooth as possible. These are client libraries that connect, through REST API calls, to our cloud.

Java and the JVM

This library is for Java, and for all programming languages running on the Java Virtual Machine including KotlinScala, Groovy, and many more.

This library written in Java hides the REST details and offers a nice programming api. It’s open source and managed on GitHub. It uses command4j (a general-purpose command framework) and anythingworks (a rest/soap utility library for building clients and services). They’re both on GitHub, too.

You may still roll your own solution. We recommend using this library instead. Thanks to command4j, it offers many ready-made client-side interceptors such as failover, exception translation, logging, and timeouts.

Just include this in your pom.xml:

<dependency>
  <groupId>org.nameapi.client</groupId>
  <artifactId>nameapi-client</artifactId>
  <version>5.4.2</version>
</dependency>

Just include this in your build.gradle:

implementation 'org.nameapi.client:nameapi-client:5.4.2'

Download the Jar file from GitHub releases.

The whole project is on GitHub: https://github.com/optimaize/nameapi-client-java

Python

This library written in Python hides the REST details and offers a nice, well documented programming API.

Download and install library from PyPI:

pip install nameapi-client-python

The whole project is on GitHub: https://github.com/optimaize/nameapi-client-python

Create virtual environment and activate it:

python -m venv myenv
myenv\Scripts\activate

Clone the repository

git clone https://github.com/optimaize/nameapi-client-python.git
cd nameapi-client-python

Install the required libraries:

pip install -r requirements.txt

PHP

This library written in PHP hides the REST details and offers a nice, well documented programming API.

If you use Composer (recommended) then add this to your composer.json as a dependency:

"require": {
    "optimaize/nameapi-client-php": "dev-master",
}

The whole project is on GitHub: https://github.com/stefancretu/nameapi-client-php

Other Programming Languages

Call the REST web services directly using the standard HTTP protocol, and toolkits or frameworks for your programming language will simplify the task. Our OpenAPI specification (with Swagger) will make this integration simple:

https://api.nameapi.org/rest/swagger-ui/