Password Pusher – Environnement de DEV
Envoyer un mot de passe en toute sécurité – La disponibilité de la plateforme n'est pas garantie
Documentation complète de l'API JSON pour la création, la récupération et la gestion des notifications push dans l'édition open-source.
Authentifiez les requêtes avec un jeton Bearer dans l'en-tête Authorization.
Créez un jeton API dans les paramètres de votre compte à l'adresse suivante : /users/token.
Authorization: Bearer YOUR_API_TOKENGET /api/v2/version, GET /api/v2/pushes/:url_token, GET /api/v2/pushes/:url_token/previewGET /api/v2/pushes/:url_token/audit, GET /api/v2/pushes/active, GET /api/v2/pushes/expiredTous les points de terminaison sont relatifs à votre hôte d'installation :
https://dev.pwpush.aefe.fr/api/v2GET /api/v2/version
Returns API version, application details, and a features hash describing which capabilities are enabled on this instance.
Exemple cURL :
curl -X GET https://dev.pwpush.aefe.fr/api/v2/version{
"application_version": "2.6.4",
"api_version": "2.1",
"edition": "oss",
"features": {
"anonymous_access": true,
"api_token_authentication": true,
"accounts": {
"enabled": false
},
"pushes": {
"enabled": true,
"email_auto_dispatch": false,
"file_attachments": {
"enabled": true,
"requires_authentication": true
},
"url_pushes": {
"enabled": true
},
"qr_code_pushes": {
"enabled": true
}
},
"requests": {
"enabled": false
}
}
}POST /api/v2/pushesCréer une nouvelle poussée.
Format du corps : { "push": { ... } }
| Paramètres | Taper | Requis | Description |
|---|---|---|---|
payload | string | Oui | Contenu textuel secret pour les envois par SMS, URL ou QR code. |
files | array | Non | Fichiers à joindre. Le type de transfert est « fichier » sauf si un type spécifique est indiqué. |
kind | string | Non | Type de notification push : texte, fichier, URL ou QR Code. Par défaut, le format texte est utilisé si aucune valeur n’est spécifiée. |
expire_after_days | integer | Non | Délai d'expiration en jours. Si cette valeur est omise, les valeurs par défaut de l'instance seront utilisées. |
expire_after_views | integer | Non | Nombre maximal de récupérations autorisé. Si cette valeur est omise, les valeurs par défaut de l'instance sont utilisées. |
deletable_by_viewer | boolean | Non | Permet au destinataire de faire expirer la notification. |
retrieval_step | boolean | Non | Ajoute une étape supplémentaire de confirmation de récupération. |
passphrase | string | Non | Cette phrase secrète est requise pour récupérer la charge utile. |
name | string | Non | Étiquette facultative présentée au propriétaire. |
note | string | Non | Note facultative réservée au propriétaire. |
{
"push": {
"payload": "my-secret",
"expire_after_days": 1,
"expire_after_views": 5,
"passphrase": "optional-passphrase",
"deletable_by_viewer": true,
"retrieval_step": true
}
}Exemple cURL (corps JSON) :
curl -X POST https://dev.pwpush.aefe.fr/api/v2/pushes \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"push": {
"payload": "my-secret",
"expire_after_days": 1,
"expire_after_views": 5
}
}'GET /api/v2/pushes/:url_tokenRécupérer une donnée push à partir d'un jeton. Cette opération est comptabilisée comme une vue et peut entraîner l'expiration de la notification push lorsque les limites sont atteintes.
Paramètres de la requête : passphrase (facultatif, requis lorsque la notification push est protégée par une phrase de passe)
Exemple cURL :
curl -X GET https://dev.pwpush.aefe.fr/api/v2/pushes/YOUR_URL_TOKENGET /api/v2/pushes/:url_token/previewRenvoie l'URL secrète complète d'une requête push sans récupérer sa charge utile.
Exemple cURL :
curl -X GET https://dev.pwpush.aefe.fr/api/v2/pushes/YOUR_URL_TOKEN/previewGET /api/v2/pushes/:url_token/auditRetournez les entrées du journal d'audit pour une envoi. L'authentification et la propriété sont requises.
Paramètres de la requête : page (facultatif, entier, valeur par défaut 1, plage valide de 1 à 200)
Exemple cURL :
curl -X GET "https://dev.pwpush.aefe.fr/api/v2/pushes/YOUR_URL_TOKEN/audit?page=1" \
-H "Authorization: Bearer YOUR_API_TOKEN"DELETE /api/v2/pushes/:url_tokenSupprimer immédiatement une notification push. Autorisé pour les propriétaires (après authentification) ou pour les destinataires lorsque la notification a été créée avec l'option « supprimable par le lecteur » activée.
Exemple cURL :
curl -X DELETE https://dev.pwpush.aefe.fr/api/v2/pushes/YOUR_URL_TOKEN \
-H "Authorization: Bearer YOUR_API_TOKEN"GET /api/v2/pushes/activeListe des notifications push actives pour l'utilisateur authentifié.
Paramètres de la requête : page (facultatif, entier, valeur par défaut 1, plage valide de 1 à 200)
Exemple cURL :
curl -X GET "https://dev.pwpush.aefe.fr/api/v2/pushes/active?page=1" \
-H "Authorization: Bearer YOUR_API_TOKEN"GET /api/v2/pushes/expiredListe des notifications expirées pour l'utilisateur authentifié.
Paramètres de la requête : page (facultatif, entier, valeur par défaut 1, plage valide de 1 à 200)
Exemple cURL :
curl -X GET "https://dev.pwpush.aefe.fr/api/v2/pushes/expired?page=1" \
-H "Authorization: Bearer YOUR_API_TOKEN"200 - Requête réussie201 - Push créé400 - Paramètres de requête invalides401 - Authentification requise ou jeton invalide403 - Interdit à l'utilisateur actuel404 - Ressource non trouvée422 - Erreur de validationPour la documentation de l'API v1 héritée, voir /api.