topsoft4u/pq-api-connector

Allows you to connect to API instances running on ProQoS platform.

1.0.1 2024-04-18 11:45 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-json: *

MIT

• Łukasz Kolasa

• api
• connector
• proqos

README

API Connector for websites using ProQoS backend services

Type-safe PHP connector for websites using ProQoS backend services.

Requirements

• Minimum PHP Version: 7.4
• Dependencies: ext-curl, ext-json

Application

This connector can be used for the following websites:

Website	📕 Documentation
e-hedo.pl	📕 LINK
magboss.pl	📕 LINK
hedo-electro.com	📕 LINK
hedo-pets.com	📕 LINK

Note: For each website, you need a separate API key. To get one, please use the contact form on specific website.

Installation

You can install the connector via Composer using the following command:

composer require topsoft4u/api-connector

Usage

Each method has its own example in the examples directory.

For explanation of each method, please refer to the API documentation links mentioned earlier.

Functions

• Type-safe methods and responses with null-type support.
• Client (connector) validations before sending requests.
• Error handling with exceptions.
• Option to change output language.
• Option to change the output format (JSON/XML).
• You can fetch the JSON/XML file without parsing (usable for testing).
• Test mode for POST methods (sends data to the server, but it's not saved).

Releasing a new version

1. Update the version in the composer.json file with bash /scripts/bump_version.sh.
2. Finish the release with bash /scripts/commit_tag_push.sh - which will create a new tag and push it to the repository.