Documentation← Retour à l'accueil
API publique
L'API permet à vos scripts FiveM (Lua/JS) d'envoyer des mails RP depuis des adresses de votre organisation. Très pratique pour automatiser : factures de banque, courriers d'embauche, notifications de services publics, etc.
Authentification
Toutes les requêtes utilisent votre clé API en en-têteAuthorization: Bearer …. La clé est visible dans votre tableau de bord et peut être régénérée à tout moment.
Envoyer un mail
POST https://france-roleplay.fr/api/v1/mails
Corps (JSON)
{
"from": "banque", // partie locale OU "banque@<votre-slug>.rp" -- doit appartenir à votre organisation
"to": "jean.dupont@autre.rp", // adresse destinataire complète (votre org ou une autre)
"subject": "Votre relevé bancaire",
"body": "Bonjour, voici votre relevé du mois..."
}Réponse 200
{ "ok": true, "mail_id": "42",
"from": "banque@lossantos.rp",
"to": "jean.dupont@autre.rp" }Codes d'erreur
401 missing_authorization / invalid_api_key403 from_not_in_org— l'adressefromn'est pas dans votre organisation.404 from_unknown— la boîte expéditrice n'existe pas.400 missing_fields / invalid_jsonou message de l'erreur.429 rate_limited— 60 requêtes / minute / clé maximum.
Exemple cURL
curl -X POST https://france-roleplay.fr/api/v1/mails \
-H "Authorization: Bearer frm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"from":"banque","to":"jean@lossantos.rp","subject":"Test","body":"Bonjour Jean"}'Exemple Lua (FiveM)
local function sendRpMail(from, to, subject, body)
PerformHttpRequest(
"https://france-roleplay.fr/api/v1/mails",
function(code, text, headers) print("[FRMail] "..code.." "..text) end,
"POST",
json.encode({ from = from, to = to, subject = subject, body = body }),
{ ["Authorization"] = "Bearer frm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
["Content-Type"] = "application/json" }
)
end
-- Exemple : facture bancaire
sendRpMail("banque", "jean.dupont@lossantos.rp",
"Votre relevé", "Bonjour Jean, voici votre relevé du mois.")Webhook entrée de mail
Vous pouvez configurer une URL dans Réglages qui sera appelée en POST JSON à chaque mail reçu par une boîte de votre organisation.
Payload
{ "event": "mail.received",
"mail_id": "42",
"from": "expediteur@autre.rp",
"to": "destinataire@votreorg.rp",
"subject": "...",
"body": "...",
"sent_at": "2026-06-07T22:00:00.000Z" }Le webhook est en mode fire-and-forget: son échec n'empêche pas la livraison du mail. Prévoyez un endpoint idempotent et rapide.