Download the PHP package elvesora/enrichment-laravel without Composer

Elvesora Enrichment for Laravel

Self-contained Laravel 12 and 13 client for the Elvesora Company Enrichment API, with auto-discovery, dependency injection, a namespaced facade, immutable results and credit metadata, typed exceptions, idempotency support, and publishable configuration.

This is a client-only package. By default, it performs one outbound HTTPS request to the Enrichment API for each call. It does not require a database, Redis, a cache, queues, workers, migrations, or package-owned server infrastructure; API-side enrichment, credit accounting, and idempotency storage remain the responsibility of the Elvesora service.

Requirements

• PHP 8.2 or later
• PHP json and mbstring extensions
• Laravel 12 or 13
• An Elvesora API key

Laravel 13 requires PHP 8.3 or later.

Obtain and manage the key through the Elvesora Enrichment documentation. Keep it in server-side configuration; never expose it in browser or mobile client code.

Installation

The service provider is discovered automatically. This package contains its own Guzzle client and does not require elvesora/enrichment-php.

Configuration

Add the API key to .env:

Optional settings:

Timeout values are seconds and must be finite and greater than zero. The connection timeout is capped internally at the total timeout. A custom base URL must be an absolute HTTP or HTTPS URL with a host and cannot contain embedded credentials, a query string, or a fragment. Keep production endpoints on HTTPS; plain HTTP is intended only for controlled local testing. Redirects are not followed, so domain data stays on the configured API origin. The user agent must be a non-empty, valid UTF-8 string without control characters.

Publish the configuration when you need to customize or inspect it:

Credentials are checked only when the client is first resolved, so package discovery and unrelated Artisan commands do not require an API key.

Dependency injection

Facade

The facade is namespaced and is not registered as a global Laravel alias.

Results and credits

EnrichmentResult exposes readonly properties for:

• success, resultType, and message
• data, containing the structured company payload
• domain, a nullable convenience value read from data.domain
• credits, an immutable CreditMetadata object
• statusCode and an optional API responseCode
• idempotencyStatus, which is replayed when the API returns a cached idempotent response

CreditMetadata exposes readonly limit, used, remaining, consumedByRequest, periodStartedAt, and periodEndsAt properties. Use $result->toArray(), $result->credits->toArray(), or json_encode() when arrays or JSON are more convenient.

$result->isEnriched() confirms the successful ENRICHED contract. $result->wasReplayed() reports whether Idempotency-Status: replayed was present.

Idempotency

The optional idempotency key is sent as Idempotency-Key. Responses are retained by the API for 24 hours. Reusing a key with the same domain returns the retained response without consuming another credit. Reusing it with a different domain throws IdempotencyConflictException and exposes idempotencyStatus === 'conflict'.

Domains and idempotency keys must be valid UTF-8. They are trimmed and limited to 255 characters. An empty optional key is omitted. Invalid local values are rejected before an HTTP request and consume no credit.

Errors and retries

Exception reference

All package API exceptions extend Elvesora\Enrichment\Laravel\Exception\EnrichmentException. It exposes readonly statusCode, resultType, retryable, retryAfter, responseBody, credits, and idempotencyStatus properties. Retryable gateway responses preserve a numeric Retry-After value even when their body is malformed. API keys are never added to exception messages or retained transport exceptions, and native plus Symfony/Laravel debug output redacts the stored key. Treat responseBody as application data and redact it according to your logging policy.

Exception selection follows result_type before HTTP status. For example, an upstream failure preserved as HTTP 422 with result_type: UPSTREAM_ERROR remains an ApiException, not a local request-validation exception. An upstream 429 is a retryable ApiException; an account-level LIMIT_EXCEEDED response remains a non-retryable UsageLimitException.

The client does not retry automatically. A successful ENRICHED response normally consumes one credit; an idempotent replay reports consumedByRequest === 0. Non-chargeable HTTP 400 outcomes, conflicts, local validation failures, exhausted-credit responses, and server failures do not consume an enrichment credit according to the API response metadata. Use explicit retry policy in your application and reuse the same idempotency key for a retry of the same logical request.

Testing applications

Replace the interface binding with a test double; no live HTTP request is needed:

Package development

The test suite uses mocked HTTP responses and sends no requests to the live Elvesora API.

License

MIT. See LICENSE.