README

API pour envoyer et suivre des Lettres Recommandées En Ligne distribuées par le facteur

Elle comprend les fonctions clés pour :

• créer un envoi,
• ajouter des documents et des destinataires,
• choisir ses options,
• suivre la production.

Pour connaître les notifications (webhooks) concernées par cette API, consultez la documentation de l'API notification_center.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, run the following:

composer require jp10/maileva-registered-sdk

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: oAuth2PasswordProduction
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oAuth2PasswordSandbox
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\DestinatairesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sending_id = 'sending_id_example'; // string | Identifiant d'un envoi
$recipient_creation = new \OpenAPI\Client\Model\RecipientCreation(); // \OpenAPI\Client\Model\RecipientCreation

try {
    $result = $apiInstance->createRecipientOfSending($sending_id, $recipient_creation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DestinatairesApi->createRecipientOfSending: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.sandbox.maileva.net/registered_mail/v4

Models

• DeliveryStatus
• DocumentMetadata
• DocumentResponse
• DocumentStatus
• DocumentsOverrideItem
• DocumentsResponse
• EnvelopeType
• ErrorResponse
• ErrorsResponse
• GlobalDepositProofResponse
• GlobalDepositProofsResponse
• MainDeliveryStatusResponse
• Mapping
• MappingDataInner
• PagingResponse
• PostageClass
• Priority
• RecipientCreation
• RecipientResponse
• RecipientStatus
• RecipientUpdate
• RecipientsCounts
• RecipientsResponse
• SendingCreation
• SendingResponse
• SendingStatus
• SendingUpdate
• SendingsResponse
• Statuses

Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

oAuth2PasswordProduction

• Type: OAuth
• Flow: password
• Authorization URL: ``
• Scopes:
  • all: CRUD on resources

oAuth2PasswordSandbox

• Type: OAuth
• Flow: password
• Authorization URL: ``
• Scopes:
  • all: CRUD on resources

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 4.4
• Build package: org.openapitools.codegen.languages.PhpClientCodegen