Download the PHP package webmenedzser/uvb-connector without Composer
On this page you can find all versions of the php package webmenedzser/uvb-connector. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package uvb-connector
Utánvét Ellenőr API Connector
This package is the PHP connector library for the Utánvét Ellenőr API 1.x.
Installing
The easiest way to install the Connector 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 UVBConnector
instance and calling its get()
or post($outcome)
method.
The UVBConnector
class takes care of the communication between your app and the Utánvét Ellenőr API.
General usage
Get e-mail reputation from Utánvét Ellenőr API
The API will answer with a JSON string with a structure like this:
If you would like to display these values, use the numeric totalRate
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
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"?)
Submit order outcome to Utánvét Ellenőr API
Payload data members:
- outcome: +1 if successful, -1 if refused/unclaimed.
- orderId: Public-facing ID of the order, which can be used by anyone to identify the order.
- phoneNumber: Phone number in international 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.
Order status changes are the endorsed and ideal events to trigger these API calls.
Sandbox environment
By setting the 4th parameter of UVBConnector constructor to false, the library will use the sandbox environment instead of the production one. Please use this when you are experimenting with your shop or integration.
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!