Download the PHP package xqueue/maileon-partner-api-client without Composer
On this page you can find all versions of the php package xqueue/maileon-partner-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xqueue/maileon-partner-api-client
More information about xqueue/maileon-partner-api-client
Files in xqueue/maileon-partner-api-client
Package maileon-partner-api-client
Short Description Partner API Client to XQ:Maileon
License MIT
Homepage https://www.maileon.de
Informations about the package maileon-partner-api-client
Maileon Partner API Client
Provides an API client to connect to XQueue Maileon's Partner REST API and (de-)serializes all API functions and data for easier use in PHP projects.
Maileon's REST API documentation can be found here.
Table of contents
- Requirements
- Installation
- Usage
- Examples
- Tests
Requirements
The API client requires PHP >= 8.1
with libcurl
.
Additionally all requests use an SSL encrypted API endpoint. To enable SSL support in CURL, please follow these steps:
- Download the official SSL cert bundle by CURL from https://curl.haxx.se/ca/cacert.pem
- Save the bundle to a directory that can be accessed by your PHP installation
- Add the following entry to your php.ini (remember to change the path to where you put the cert bundle):
Installation
You can add this library to your project using Composer:
Usage
The API client divides the features of Maileon's Partner REST API into specific consumable services. Each service provides all functions of it's specific category.
-
AccountService:
- Manage newsletter and customer accounts, api keys, mailing domains.
-
BlacklistService:
- Manage your blacklists.
-
ContingentService:
- Manage contingents and prepaid status.
-
DistributorReportService:
- Get Volume and SMS Reports.
-
GeneralService:
- Get domains list, validate domain, get locales.
-
JobService:
- Get jobs, create account job.
-
ProductService:
- Manage products and upload templates.
-
ReportService:
- Get report checks and report CSAs.
-
RoleService:
- Create or delete custom roles.
-
UserService:
- Manage user accounts and roles.
- WebhookService:
- Manage webhooks.
Examples
Get Newsletter Accounts:
Create Job:
Tests
In order to run the unit tests you need to have Docker installed.
First you need to create a .env file and add your API key:
Run the following commands to create the container and install the required packages:
Run the following commands to run the tests: