NAV Navbar
javascript java php shell

Introduction

Bienvenue sur l'API Bodyguard ! Vous pouvez utiliser cette API afin d'analyser un texte et savoir si ce dernier est haineux ou non.

Nous vous fournissons des exemples de codes dans la partie droite afin de vous montrer comment utiliser l'API sur différents langages (Shell, Java, PHP, Javascript).

Authentification

Vous devez avoir une Clef afin d'accéder à l'API. Vous pouvez obtenir une clef gratuitement directement sur notre site développeur.

A chaque appel vers l'API Bodyguard, vous devrez ajouter un header contenant votre clef API afin d'autoriser la requête, exemple :

Authorization: Bearer VOTRE_CLEF_API

Moderation

Obtenir l'analyse de Bodyguard

HttpResponse<JsonNode> jsonResponse = Unirest.post("https://api.bodyguard.ai/1.0/moderation")
    .header("Authorization", "Bearer VOTRE_CLEF_API")
    .field("text", "T'es vraiment très belle, non je rigole MDR, tout l'inverse")
    .asJson();
$url = 'https://api.bodyguard.ai/1.0/moderation';
$data = array("text" => "T'es vraiment très belle, non je rigole MDR, tout l'inverse");

$options = array(
    'http' => array(
        'header'  => "Authorization: Bearer VOTRE_CLEF_API \r\n" .
                     "Content-type: application/x-www-form-urlencoded",
        'method'  => 'POST',
        'content' => http_build_query($data)
    )
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
curl "https://api.bodyguard.ai/1.0/moderation"
  -H "Authorization: Bearer VOTRE_CLEF_API"
  -X POST
  -d "text=T'es vraiment très belle, non je rigole MDR, tout l'inverse"
$.ajax({
    beforeSend: function(request) {
        request.setRequestHeader("Authorization", 'Bearer VOTRE_CLEF_API');
    },
    dataType: "json",
    type: "POST",
    url: 'https://api.bodyguard.ai/1.0/moderation',
    data: {
        text: "T'es vraiment très belle, non je rigole MDR, tout l'inverse"
    },
    success: function(data) {

        if (data.code == undefined) {

            // Boolean définissant le caractère haineux du texte selon Bodyguard.
            var haineux = data.haineux;

        } else {
            // Une erreur est survenue.
        }

    }
});

La commande ci-dessus retourne un JSON structuré des façons suivantes (en fonction de votre pack) :

Basique (GRATUIT)

{
    "haineux": true
}

Entreprise (PAYANT)

{
    "haineux": true,
    "gentil": false,
    "type": "Moquerie"
}

Cette fonction renvoie le résultat de l'analyse de Bodyguard afin de savoir si un texte est haineux ou non.

Requête HTTP

POST https://api.bodyguard.ai/1.0/moderation

Paramètres de la requête

Paramètre Type Description
text Texte Le texte que vous souhaitez analyser avec l'intelligence artificielle de Bodyguard.

Erreurs

En cas d'erreur, l'API retourne un JSON structuré de la façon suivante :

{
    "code": 401,
    "title": "Non authorisée",
    "description": "Votre clef API est éronnée."
}

L'API Bodyguard utilise les codes d'erreur suivants :

Code Description
400 Mauvaise Requête -- Votre requête est invalide.
401 Non authorisée -- Votre clef API est éronnée.
402 Quota atteint -- Vous avez atteind votre quota journalier, contactez-nous afin de l'augmenter !
404 Introuvable -- La fonction que vous tentez d'appeler est introuvable.
429 Trop de requêtes -- Vous effectuez trop de requêtes, ralentissez un peu !
500 Erreur interne -- Nous rencontrons actuellement des problèmes avec nos serveurs, veuillez réessayer plus tard :)
503 Service indisponible -- Il n'y a aucun robot disponible pour traiter votre requête, nous sommes probablement en maintenance !