README

Infrastructure générique pour satellites Laravel connectés à une API externe.

Fournit :

SatelliteClient — classe abstraite HTTP avec get(), post(), put(), delete(), logging intégré et gestion d’erreurs typée
VerifyWebhookSignature — middleware HMAC SHA-256 timing-safe pour les webhooks entrants
SatelliteInstallCommand — commande satellite:install pour publier config, stubs et configurer le canal de log

Prérequis

PHP 8.2+
Laravel 11 ou 12

Installation

composer require moko-github/api-si-satellite

Publier les fichiers

php artisan satellite:install

Ou manuellement :

php artisan vendor:publish --tag=satellite-config
php artisan vendor:publish --tag=satellite-stubs

Variables d’environnement

SATELLITE_API_URL=https://api.example.com
SATELLITE_API_TOKEN=ton-token
SATELLITE_API_TIMEOUT=10
SATELLITE_WEBHOOK_SECRET=un-secret-long-et-aléatoire
SATELLITE_LOG_LEVEL=debug
SATELLITE_LOG_CHANNEL=satellite
# Mettre à false uniquement si l’API utilise un certificat auto-signé (ex : qualification)
SATELLITE_VERIFY_SSL=true

Variable	Défaut	Rôle
`SATELLITE_API_URL`	—	URL de base de l’API distante
`SATELLITE_API_TOKEN`	—	Token Bearer pour l’authentification
`SATELLITE_API_TIMEOUT`	`10`	Timeout HTTP en secondes
`SATELLITE_WEBHOOK_SECRET`	—	Secret HMAC SHA-256 pour vérifier les webhooks (généré automatiquement par `satellite:install`)
`SATELLITE_LOG_LEVEL`	`debug`	Niveau de log du canal `satellite` dans `config/logging.php`
`SATELLITE_LOG_CHANNEL`	`satellite`	Canal Laravel à utiliser pour les logs du client HTTP
`SATELLITE_VERIFY_SSL`	`true`	Vérification du certificat SSL. Mettre à `false` pour les environnements avec certificats auto-signés (ex : qualification)

SATELLITE_LOG_LEVEL contrôle à quel niveau on logue (debug, info, warning…). SATELLITE_LOG_CHANNEL contrôle dans quel canal on logue. Les deux sont complémentaires : le canal satellite est créé dans config/logging.php par satellite:install, avec SATELLITE_LOG_LEVEL comme niveau minimum.

Utilisation

1. Créer un client HTTP spécifique

Étendre SatelliteClient dans le package privé de l’application :

use Moko\\Satellite\\Services\\SatelliteClient;

final class MyApiClient extends SatelliteClient
{
    public function __construct()
    {
        parent::__construct(
            baseUrl:    (string) config('my-api.url'),
            token:      (string) config('my-api.token'),
            timeout:    (int)    config('my-api.timeout', 10),
            logChannel: 'my-api',
            verifySSL:  (bool)   config('my-api.verify_ssl', true),
        );
    }

    public function getResource(int $id): MyResourceDTO
    {
        return MyResourceDTO::fromArray($this->get("/api/v1/resources/{$id}"));
    }
}

2. Protéger une route webhook

use Moko\\Satellite\\Http\\Middleware\\VerifyWebhookSignature;

// Clé par défaut : config('satellite.webhook_secret')
Route::post('/webhooks/my-api', MyWebhookController::class)
    ->middleware(VerifyWebhookSignature::class);

// Clé personnalisée (package privé avec sa propre config) :
Route::post('/webhooks/my-api', MyWebhookController::class)
    ->middleware(VerifyWebhookSignature::class.':my-api.webhook_secret');

Le middleware lit l’en-tête X-Webhook-Signature et la compare via hash_equals (temps constant).

3. Utiliser les stubs publiés

Après satellite:install, deux stubs sont disponibles dans stubs/satellite/ :

Stub	Usage
`WebhookController.stub`	Contrôleur de réception des webhooks
`SyncJob.stub`	Job de synchronisation cursor-based

Gérer les erreurs

SatelliteException expose statusCode, endpoint et errors :

use Moko\\Satellite\\Services\\SatelliteException;

try {
    $data = $client->getResource(42);
} catch (SatelliteException $e) {
    Log::error('API error', [
        'status'   => $e->statusCode,
        'endpoint' => $e->endpoint,
        'errors'   => $e->errors,
    ]);
}

Tester la connectivité

La commande satellite:ping vérifie que l'application peut joindre l'API distante.

# Endpoint par défaut (/health)
php artisan satellite:ping

# Endpoint personnalisé (ex : api-si)
php artisan satellite:ping --endpoint=/api/v1/health

# Surcharger l'URL (tester un environnement sans modifier .env)
php artisan satellite:ping --endpoint=/api/v1/health --url=https://api-qualification.example.com

# Appel sans token Bearer (endpoint vraiment public)
php artisan satellite:ping --endpoint=/api/v1/health --no-token

Exemple de sortie en succès :

Satellite Ping

  ● GET https://api.example.com/api/v1/health … 200 OK (42ms)

  {"status":"ok","version":"1.2.3"}

Exemple de sortie en erreur :

Satellite Ping

  ● GET https://api.example.com/api/v1/health … 500 (120ms)

Structure

src/
├── SatelliteServiceProvider.php
├── Console/Commands/
│   └── SatelliteInstallCommand.php
├── Http/Middleware/
│   └── VerifyWebhookSignature.php
└── Services/
    ├── SatelliteClient.php
    └── SatelliteException.php
config/
└── satellite.php
stubs/
├── SyncJob.stub
└── WebhookController.stub

Licence

MIT

moko-github / api-si-satellite

Maintainers

Package info

Statistics

Security