Guide de Démarrage Rapide

Maintenant qu’Apprise est installé, envoyons votre première notification. Choisissez la méthode qui vous convient le mieux ci-dessous.

CLI

La façon la plus rapide de tester Apprise est d’utiliser la ligne de commande.

# Envoyer une notification vers un service spécifique
apprise -t "Bonjour" -b "Monde" \
    "discord://webhook_id/webhook_token"

Python

Si vous êtes développeur, voici comment utiliser Apprise dans un script Python :

import apprise

# Créer une instance Apprise
apobj = apprise.Apprise()

# Ajouter des services de notification via des URL
apobj.add('mailto://user:pass@gmail.com')
apobj.add('discord://webhook_id/webhook_token')

# Envoyer une notification
apobj.notify(
    body='Ceci est une notification de test !',
    title='Bonjour le monde',
)

Serveur API

Assurez-vous que votre conteneur API Apprise est en cours d’exécution (voir Installation).

1. Sans État (Le Plus Rapide)

Vous pouvez envoyer une notification immédiatement sans rien configurer sur le serveur en passant les URL dans la requête.

# Envoyer une notification via curl
curl -X POST \
  -d 'urls=discord://webhook_id/webhook_token' \
  -d 'body=Bonjour le monde' \
  http://localhost:8000/notify

2. L’Interface Web

L’API inclut un gestionnaire de configuration intégré à l’adresse http://localhost:8000.

Étape 1 : Choisir une Clé

Les configurations sont stockées sous un ID de configuration unique (ou clé). Choisissez un mot-clé (par exemple mes-alertes) pour commencer.

Étape 2 : Ajouter une Configuration

Saisissez vos URL Apprise (au format TEXT ou YAML) et enregistrez-les sous votre clé.

Étape 3 : Vérifier et Étiqueter

Vérifiez que vos URL sont bien chargées. Vous pouvez voir les tags qui leur sont associés afin de cibler certains groupes plus tard.

Étape 4 : Envoyer une Notification

Passez à l’onglet Notifications. Sélectionnez les tags à cibler (ou laissez vide pour notifier tout le monde), puis envoyez votre notification.

API Développeur (Swagger)

L’API Apprise suit la spécification OpenAPI 3.0. Vous pouvez trouver le fichier swagger.yaml à la racine du dépôt.

Étapes Suivantes

• Apprenez la Syntaxe : comprenez comment fonctionnent les URL Apprise.
• Configurez-le : apprenez à utiliser les Fichiers de Configuration pour gérer vos URL.
• Trouvez des Services : parcourez le catalogue des Services Pris en Charge.