Download the PHP package foxentry/php-api-client without Composer

On this page you can find all versions of the php package foxentry/php-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of foxentry/php-api-client

Informations about the package php-api-client

Foxentry PHP API Client library Documentation

Introduction

The Foxentry PHP API Client library enables seamless integration of various data validation features into your applications. Whether you require validation for phone numbers, addresses, emails, or other data types, this library offers a user-friendly interface to interact with the Foxentry API. For more comprehensive information about Foxentry, please visit foxentry.com

If you have questions or need further assistance, reach out to us at [email protected]

Requirements

To use the Foxentry API client, you need the following:

Installation

To begin using the Foxentry PHP API Client library, follow these installation steps:

With Composer

  1. Install the library using Composer:

  2. Include the Composer autoloader in your PHP script:

Without Composer

  1. Download the library and add it to your project.
  2. Include the file vendor/autoload.php in your PHP script.

Getting started

To initiate the usage of the Foxentry PHP API Client library, create an instance of the API client with your API key. This instance allows you to access various resources (e.g., phone, location, email, etc.) and call their methods to access the Foxentry API's functionalities.

Full example of e-mail validation

APIClient class

The APIClient class is the main class responsible for communication with the API.

It offers the following methods:

Method Parameters Description
setAuth API key Sets API key, that will be used in requests
setApiVersion version number Sets specific API version, that will be used

To access various resources from this class, simply provide the resource name, and you will be able to access the resource's methods, e.g., $api->email()->search($query), $api->company()->get($query), etc.

Resources

The API client provides various resources, each with its own related methods listed below. You can click on the methods to navigate to the API documentation, where you can explore all request inputs, options, and more.

Resource Methods
Company validate
search
get
Email validate
search
Location validate
search
get
localization
Name validate
Phone validate

In each method, you must specify query parameters according to the specific endpoint in the API documentation.

To specify options, use the method setOptions([])

To specify the client, use the methods setClientIP($ip), setClientCountry($country) or setClientLocation($lat, $lon).

Response class

Response class is returned with every request providing methods below:

Method Parameters Description
getStatus None Returns status code of the response
getResponse None Returns full response from the API
getRequest None Returns informations about the sent request
getResult None Returns result object from the response
getResultCorrected None Returns corrected results from the response
getSuggestions None Returns suggestions from the response
getErrors None Returns errors from the response
getHeaders None Returns request headers from the response
getRateLimit None Returns request rate limit for the API
getRateLimitPeriod None Returns reset period of request rate limit
getRateLimitRemaining None Returns remaining rate of requests
getDailyCreditsLeft None Returns remaining daily credits
getDailyCreditsLimit None Returns daily credits limit
getApiVersion None Returns API version used in the request

Testing

The library includes unit tests to ensure its functionality and provide examples of how the library can be used. You can run the unit tests using PHPUnit. Don't forget to set your API key for these tests by creating the phpunit.xml file.

All versions of php-api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
guzzlehttp/guzzle Version ^7.8
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package foxentry/php-api-client contains the following files

Loading the files please wait ....