Ressources GTA V
Installer la ressource
Pour récupérer la clé vous permettant d'utiliser l'api de Mail RP, rendez vous sur la page : Récupérer sa clé API
Voici deux méthodes pour installer la ressources sur votre serveur :
Avec git :
Rendez vous dans le dossier resources
de votre serveur, et utiliser la commande suivante :
--git Metaclone classhttps://github.com/Tvpirates/xelyos-fivem-resources.git MailRP[xelyos]
=
Un --dossier Initialisationva allors de créer sous le nom [xelyos], vérifiez bien que dans ce répertoire vous trouverez le répertoire mailrp.
Sans git :
Rendez vous sur le git : Last releases Git Xelyos Resources FiveM et télécharger le fichier .zip
. Déplacez le fichier zip téléchargé dans votre répertoire resources
, et faîtes extraire-ici, renommer le nouveau fichier installer en [xelyos]
Activer la ressource
Lier à l'API :
Pour lié votre serveur FiveM avec l'api de Mail RP, vous devez vous rendre dans le fichier resources/[xelyos]/mailrp/server.lua
, au niveau de la classeligne Mail6, RPremplacez apiToken par votre clé.
Activer la ressource :
Pour activer la ressource sur votre serveur, ajouter dans votre server.cfg
les lignes suivantes :
# Xelyos solutions
ensure mailrp
Si vous utilisez déjà des ressources Xelyos, vous n'avez qu'à ajouter la ligne à la suite des autres.
Utiliser la ressource
La fonction callback :
function MailRP:newrequestAction(statusCode, ()
local token = 'apiToken'
self.__index = self
self._api = "https://mail-rp.com/api/v1/" .. token .. '/'
return self
endresultData)
-- EnvoyerAction unequi suit la requête
GET
function MailRP:__sendGetRequest(url, callBack)
if callBack and type(callBack) ~= 'table' then
error('The callBack must be a function and not ' .. type(callBack))
end
PerformHttpRequest(self._api
Lorsque url,vous function(statusCode,allez resultData)faire ifappel callBackà thenl'API, callBack(statusCode,un json.decode(resultData))résultat endest end,envoyé 'GET')en endfonction --de Envoyer unela requête POSTque vous utilisez. Pour exploiter cette réponse, vous devrez utilisez une fonction callback, dans cette fonction écrivez les actions qui devront suivre la requête. Vous pouvez renommer la fonction callback comme vous le voulez.
Variable | Définition |
---|---|
statusCode (obligatoire) | Résultat du status de la requête (200 : réussite | 403 : échec) |
resultData (obligatoire) | Données retournées au format JSON |
Appelez le code depuis un fichier serveur :
Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :
function MailRP:__sendPostRequest(url,requestAction(statusCode, data,ResultData)
callBack)
if type(data) ~= 'table' then
error('post data must be a table')...
end
ifTriggerEvent('xelyos:MailRP', callBackfunction(mailRP)
andmailRP:methode(requestAction)
type(callBack)end)
~=
Vous thentrouverez error('Thela callBackliste mustdes beméthodes aci-dessous !
Appelez le code depuis un fichier client :
Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :
function andrequestAction(statusCode, not 'ResultData)
.. type(callBack)).
end
PerformHttpRequest(self._api .. url,TriggerServerEvent('xelyos:MailRP', function(statusCode,mailRP)
resultData)mailRP:methode(requestAction)
ifend)
callBack
Vous callBack(statusCode,trouverez json.decode(resultData)la liste des méthodes ci-dessous !
Liste des méthodes
getServer()
Utilité end, 'POST', json.encode(data), { ['Content-Type'] = 'application/json' })
end
--: Récupérer les informations généralessur son serveur
Doc API : Gestion du serveur function- MailRP:Informations générales
Appel :
mailRP:getServer(callBack)
self:__sendGetRequest('server',
Variable | Définition |
---|---|
Aucune | Aucune |
findSubdomains()
Utilisé string')
end
if callBack and type(callBack) ~= 'table' then
error('The callBack must be a function and not ' .. type(callBack))
end
self:__sendGetRequest('server/' .. name, callBack)
end
end
--: Récupérer la liste des sous domaines functionde MailRP:getSubdomains(callBack)votre self:getSubdomain(callBack)serveur
Appel from,:
mailRP:findSubdomains(callBack) ~= 'table' then
error('The callBack must be a function and not ' .. type(callBack))
end
self:__sendPostRequest(self, 'mail/send', data, callBack)
end
function MailRP:addAddress(callBack, name, firstname, email, password)
local params = {
{ var = name, name = 'name' },
{ var = firstname, name = 'firstname' },
{ var = email, name = 'email' },
{ var = password, name = 'password' }
}
for p in pairs(params) do
if params[p].var == nil then
error(params[p].name .. ' param is required !')
end
if type(params[p].var) ~= 'string' then
error(params[p].name .. ' must be a string and not ' .. type(params[p].var))
end
end
if callBack and type(callBack) ~= 'table' then
error('The callBack must be a function and not ' .. type(callBack))
end
local data = {
name = name,
firstname = firstname,
email = email,
password = password,
}
self:__sendPostRequest(self, 'address/create', data, callBack)
end
function MailRP:getAddress(callBack, email)
if email == nil then
error('email param is required !')
end
if type(email) ~= 'string' then
error('email must be a string and not ' .. type(email))
end
if callBack and type(callBack) ~= 'table' then
error('The callBack must be a function and not ' .. type(callBack))
end
self:__sendGetRequest('address/get/' .. email, callBack)
end
RegisterNetEvent("xelyos:MailRP") -- For opening the emote menu from another resource.
AddEventHandler("xelyos:MailRP", function(cb)
cb(MailRP:new())
end)
Variable | Définition |
---|---|
Aucune | Aucune variable mise à part la fonction permettant d'exploiter les résultats n'est nécessaire |