libriciel / comelus-api-wrapper

3.0.0 2025-09-19 08:56 UTC

Requires

• php: >=8.3
• ext-json: *
• nyholm/psr7: ^1.8
• php-http/multipart-stream-builder: ^1.4
• psr/http-client: ^1.0
• psr/http-factory: ^1.1
• symfony/http-foundation: ^7.3
• symfony/mime: ^7.3

Requires (Dev)

• phpunit/phpunit: ^12.3
• symfony/uid: ^7.3

AGPL-3.0-or-later

• Théo GUILLON

Published on Packagist.org on 2025-09-19 08:58 UTC

README

Wrapper php de l'api de comelus.

Prérequis

PHP >= 8.3 Compatible uniquement avec ComElus v1.3.0

Installation

composer require libriciel/comelus-api-wrapper

Initialisation

// Le plus simple reste d'injecter le service
$client = new ClientImplementation();
$requestFactory = new RequestFactoryImplementation()
$streamFactory = new StreamFactoryImplementation()
$ceWrapper = new ComelusWrapper($client, $requestFactory, $streamFactory);

$ceWrapper->setKey("structure_api_key");
$ceWrapper->setUrl("https://comelus.fr");

Verification de la connexion

$ceWrapper->check();

Lister les listes de diffusions

$ceWrapper->getMailingLists();

Lister les dossiers

$ceWrapper->getDocuments();

Récuperer les status d'un dossier

$ceWrapper->getDocumentStatus('documentId');;

Creer un dossier

$ceWrapper->createDocument('name', 'mailingListId', 'description', files[]);;

Envoyer un dossier

$ceWrapper->sendDocument('documentId');