Skip to content

Foxentry/kotlin-sdk

Repository files navigation

com.foxentry.foxentrysdk

Welcome to our com.foxentry.foxentrysdk. We are committed to providing you with the best SDK services experience possible. Please use our step-by-step instructions to become familiar with how to use our SDK.

  • Current API version: 2.0
  • Current package version: 1.0.0

Table of Contents

Requirements

  • Installed Java, stable version >= 17. If you do not have it installed, please refer to the Oracle website.
  • Foxentry.com API credentials.

Installation

Use this command to install com.foxentry.foxentrysdk in your terminal.

Linux/macOS

./mvnw install

Windows

./mvnw.cmd install

Usage

In case that you successfully installed our com.foxentry.foxentrysdk please execute this code:

import com.foxentry.foxentrysdk

fun main(args: Array<String>) {
  var config = Config(token = "YOUR_API_KEY"),
  val sdk = FoxentrySdk(config)

  sdk.CompanyService.validateCompanyData(/* query parameters */)
}

Features

Kindly note that every URI is relative to https://api.foxentry.com.

The table displays all features categorized based on their specific purposes.

Class Method HTTP request Description
FoxentrySdk.CompanyService validateCompanyData POST /company/validate Validate company data
FoxentrySdk.CompanyService companySearch POST /company/search Search company
FoxentrySdk.CompanyService getCompanyData POST /company/get Get company data
FoxentrySdk.EmailService validateEmail POST /email/validate Validate email
FoxentrySdk.EmailService emailSearch POST /email/search Search email
FoxentrySdk.LocationService locationValidation POST /location/validate Validate location data
FoxentrySdk.LocationService locationSearch POST /location/search Search location
FoxentrySdk.LocationService locationGet POST /location/get Get location data
FoxentrySdk.LocationService locationLocalization POST /location/localize Localization
FoxentrySdk.NameService nameValidation POST /name/validate Validate name data
FoxentrySdk.PhoneService validatePhoneNumber POST /phone/validate Validate phone number

Contributing

To learn more about the possibility of contributing to the subsequent development of this SDK, please visit our contributing page. Kindly note that contributions are limited by a unique set of rules in order to ensure clarity.

License

Please refer to the license page for more information about the license type and the corresponding terms of use.

Contact

We kindly request that you direct all questions to our support email:

Frequently Asked Questions (FAQ)