Download the PHP package utanvet-ellenor/client-php without Composer

On this page you can find all versions of the php package utanvet-ellenor/client-php. 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 utanvet-ellenor/client-php

Informations about the package client-php

Utánvét Ellenőr API Connector

This package is the PHP client library for the Utánvét Ellenőr API 2.x.

Installing

The easiest way to install is using Composer:

Then use your framework's autoload, or simply add:

Manual installation – If you wish to omit using Composer altogether, you can download the sources from the repository and use any PSR-4 compatible autoloader.

Getting started

You can start making requests to the Utánvét Ellenőr API just by creating a new Client instance and calling its sendRequest() or sendSignal() method.

The Client class takes care of the communication between your app and the Utánvét Ellenőr API.

General usage

Get Customer reputation from Utánvét Ellenőr API 2.0

Query by e-mail only:

Query by multiple parameters:

The API answers with a JSON string, while $client->sendRequest(); will result an object with the structure below:

Reasons & possible status values

The API will return an HTTP 200 status code if the request is processed, regardless its result. The status value might be different based on the result of the request.

reason status code
Test hash was used. 200
Run out of request quota for current billing period, upgrade your subscription to resolve! 402
Active exception found for this hash in your account. 200
Temporary e-mail was used. 204
Mailbox does not exist. 204
No Signals were found. 404
Total rate did not meet the minimum threshold set. 200
User opted out of the processing of their personal data. 451
Signals found, checks passed. 200

Required parameters

For basic verification, email and threshold are mandatory, while for extended verification, all parameters are required.

parameter e-mail only multiple parameters
email ✅ ✅
threshold ✅ ✅
phoneNumber ❌ ✅
countryCode ❌ ✅
postalCode ❌ ✅
addressLine ❌ ✅

Display results

If you would like to display these values, use the numeric reputation and/or good and bad values. Avoid aliasing these values with phrases, as they might mislead users.

Examples of using the API responses in a UI:

Good:
  • 3 successful, 2 failed (deliveries), reputation: 0.2
  • 60% successful delivery rate
  • reason value of the response (e.g. Total rate did not meet the minimum threshold set.)
Bad:
  • Order should not be fulfilled. (Why? No exact explanation is given.)
  • Too much failed deliveries. (How much is "too much"?)
  • Bad customer reputation. (What reputation is considered "bad"?)

Suggested labels (and their translations) can be found in the Reasons class of the utanvet-ellenor/client-php repository: https://github.com/utanvet-ellenor/client-php

Send Signal (order outcome) to Utánvét Ellenőr API 2.0

Order status changes are the endorsed and ideal events to trigger these API calls.

Payload data members:

property explanation
outcome +1 if successful, -1 if refused/unclaimed.
orderId Public-facing ID of the order.
phoneNumber Phone number in E.164 format, starting with the + sign, e.g.: +36209238883
countryCode Country code in ISO 3166-1 alpha-2 format (e.g.: HU)
postalCode Postal code the way it is used in the shipping address country (e.g.: 8640)
addressLine Address line, without country, country code or postal code.
Multiple address lines should be concatenated into one line.

Sandbox environment

By setting the sandbox parameter on the Client to true, it will use the sandbox environment instead of the production one.

Please use this only when you are experimenting with your shop or integration. Do not use it in production!

The sandbox API will behave the same as the production with one exception: the data it provides will be randomized - don't use it in production!

All versions of client-php with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4 || >=8.0
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 utanvet-ellenor/client-php contains the following files

Loading the files please wait ...