# Ressources GTA V - Installation

##### <span style="color: rgb(224, 62, 45);">Cette ressources n'est plus fonctionnelle pour le moment !</span>

## 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**](https://wiki.xelyos.fr/books/api-mail-rp/page/presentation-de-lapi)

Voici deux méthodes pour installer la ressources sur votre serveur :

<u>****Avec git :****</u>

<span style="white-space: pre-wrap;">Rendez vous dans le dossier </span>`<span class="editor-theme-code">resources</span>`<span style="white-space: pre-wrap;"> de votre serveur, et utiliser la commande suivante :</span>

```ssh
git clone https://github.com/XelyosTeam/fivem-resources.git [xelyos]
```

<span style="white-space: pre-wrap;">Un dossier va allors de créer sous le nom </span>****\[xelyos\]****<span style="white-space: pre-wrap;">, vérifiez bien que dans ce répertoire vous trouverez le répertoire </span>****mailrp****.

<u>****Sans git :****</u>

<span style="white-space: pre-wrap;">Rendez vous sur le git : </span>[****Last releases Git Xelyos Resources FiveM****](https://github.com/XelyosTeam/fivem-resources/releases/latest/)<span style="white-space: pre-wrap;"> et télécharger le fichier </span>`<span class="editor-theme-code">.zip</span>`<span style="white-space: pre-wrap;">. Déplacez le fichier zip téléchargé dans votre répertoire </span>`<span class="editor-theme-code">resources</span>`<span style="white-space: pre-wrap;">, et faîtes </span>**extraire-ici**<span style="white-space: pre-wrap;">, renommer le nouveau fichier installer en </span>****\[xelyos\]****

---

## Activer la ressource

<u>****Lier à l'API :****</u>

<span style="white-space: pre-wrap;">Pour lié votre serveur FiveM avec l'api de Mail RP, vous devez vous rendre dans le fichier </span>`<span class="editor-theme-code">resources/[xelyos]/mailrp/server.lua</span>`<span style="white-space: pre-wrap;">, au niveau de la ligne 6, remplacez </span>****apiToken****<span style="white-space: pre-wrap;"> par votre clé.</span>

<u>****Activer la ressource :****</u>

<span style="white-space: pre-wrap;">Pour activer la ressource sur votre serveur, ajouter dans votre </span>`<span class="editor-theme-code">server.cfg</span>`<span style="white-space: pre-wrap;"> les lignes suivantes :</span>

```cfg
# 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

<u>****La fonction callback :****</u>

```lua
function requestAction(statusCode, resultData)
  -- Action qui suit la requête
end
```

<span style="white-space: pre-wrap;">Lorsque vous allez faire appel à l'API, un résultat est envoyé en fonction de la requête que vous utilisez. Pour exploiter cette réponse, vous devrez utilisez une fonction </span>**callback**<span style="white-space: pre-wrap;">, dans cette fonction écrivez les actions qui devront suivre la requête. Vous pouvez renommer la fonction </span>**callback**<span style="white-space: pre-wrap;"> comme vous le voulez.</span>

<table id="bkmrk-variable-d%C3%A9finition-"><colgroup><col></col><col></col></colgroup><tbody><tr><th>Variable

</th><th>Définition

</th></tr><tr><td><span style="white-space: pre-wrap;">statusCode </span>

****(obligatoire)****

</td><td>Résultat du status de la requête (200 : réussite | 403 : échec)

</td></tr><tr><td><span style="white-space: pre-wrap;">resultData </span>

****(obligatoire)****

</td><td>Données retournées au format JSON

</td></tr></tbody></table>

<u>****Appelez le code depuis un fichier serveur :****</u>

Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :

```lua
function requestAction(statusCode, ResultData)
  ...
end

TriggerEvent('xelyos:MailRP', function(mailRP)
    mailRP:methode(requestAction)
end)
```

[Afficher la liste des méthodes](https://wiki.xelyos.fr/books/api-mail-rp/page/ressources-gta-v-methodes)

**Vous trouverez la liste des méthodes ci-dessous !**

<u>****Appelez le code depuis un fichier client :****</u>

Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :

```lua
function requestAction(statusCode, ResultData)
  ...
end

TriggerServerEvent('xelyos:MailRP', function(mailRP)
    mailRP:methode(requestAction)
end)
```

[Afficher la liste des méthodes](https://wiki.xelyos.fr/books/api-mail-rp/page/ressources-gta-v-methodes)

---

## Exemple d'utilisation - Récupérer le nom de son serveur

```lua
function showServerInfo(statusCode, resultData)
    print("Status", statusCode) -- Status de la requête
    print('Result', resultData) -- Informations retournées
  	print('Server name', resultData.name) -- Récupération du nom du serveur
    print('Server count api request', resultData.api.count) -- Récupérer le nombre de requêtes effectuées au total pour le serveur
end

AddEventHandler('onResourceStart', function(resourceName)
    if GetCurrentResourceName() == resourceName then
      	-- Lors de l'initialisation de la ressource
        TriggerEvent('xelyos:MailRP', function(mailRP)
            mailRP:getServer(showServerInfo)
        end)
    end
end)
```