Download the PHP package enrich-data/enrich-api-php without Composer
On this page you can find all versions of the php package enrich-data/enrich-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download enrich-data/enrich-api-php
More information about enrich-data/enrich-api-php
Files in enrich-data/enrich-api-php
Package enrich-api-php
Short Description Enrich API PHP.
License MIT
Homepage https://github.com/enrich-data/enrich-api-php
FAQ
Example:
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 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.
Informations about the package enrich-api-php
enrich-api-php
The Enrich API PHP wrapper. Enrich, Search and Verify data from your PHP services.
Copyright 2017 Crisp IM SAS. See LICENSE for copying information.
- 😘 Maintainer: @valeriansaliou
Usage
Install the library with Composer.
Then, import it:
Construct a new authenticated Enrich client with your user_id and secret_key tokens.
Then, consume the client eg. to enrich an email address:
Authentication
To authenticate against the API, get your tokens (user_id and secret_key).
Then, pass those tokens once when you instanciate the Enrich client as following:
Data Discovery
When Enrich doesn't know about a given data point, eg. an email that was never enriched before, it launches a discovery. Discoveries can take a few seconds, and sometimes more than 10 seconds.
This library implements a retry logic with a timeout if the discovery takes too long, or if the item wasn't found.
Thus, you can expect some requests, especially the Enrich requests, to take more time than expected. This is normal, and is not a performance issue on your side, or on our side. Under the hood, when you request a data point (eg. enrich a person given an email) that doesn't yet exist in our databases, the Enrich API returns the HTTP response 201 Created. Then, this library will poll the enrich resource for results, with intervals of a few seconds. The API will return 404 Not Found as the discovery is still processing and no result is yet known at this point. Once a result is found, the API will reply with 200 OK and return discovered data. If the discovery fails and no data can be aggregated for this email, the library aborts the retry after some time (less than 20 seconds), and returns a not_found error.
If a requested data point is already known by the Enrich API, it will be immediately returned, which won't induce any delay.
Resource Methods
This library implements all methods the Enrich API provides.
Verify API
Validate an Email
- Method:
$client->verify->validateEmail($query)
Enrich API
Enrich a Person
- Method:
$client->enrich->person($query)
Enrich a Company
- Method:
$client->enrich->company($query)
Enrich a Network
- Method:
$client->enrich->network($query)
