Actions Bonus

Les actions bonus sont des tâches que les participants peuvent accomplir pour gagner des points supplémentaires dans un concours. Utilisez ces points de terminaison pour récupérer les actions bonus disponibles et les marquer comme complétées.

Obtenir les Actions Bonus

GET/api/v1/entries/:entryId/bonus-actions

Public or Private API Key

Récupère toutes les actions bonus pour une participation spécifique, y compris leur statut de complétion.

Paramètres de chemin

entryIdstring required

L'identifiant unique de la participation. Utilisez 'lookup' avec des paramètres de requête pour rechercher par email.

Paramètres de requête (lorsque entryId est "lookup")

emailstring required

Adresse email à rechercher

contestIdstring required

ID du concours dans lequel effectuer la recherche

Requête

bash

# Par ID de participation
curl -X GET https://blitzrocket.com/api/v1/entries/entry_abc123/bonus-actions \
  -H "x-api-key: your_api_key_here"

# Par recherche par email
curl -X GET "https://blitzrocket.com/api/v1/entries/lookup/bonus-actions?email=jane@example.com&contestId=clx1abc123" \
  -H "x-api-key: your_api_key_here"

javascript

// Par ID de participation
const entryId = "entry_abc123";
const response = await fetch(
  `https://blitzrocket.com/api/v1/entries/${entryId}/bonus-actions`,
  {
    headers: { "x-api-key": "your_api_key_here" },
  }
);

const { data } = await response.json();
console.log(`${data.bonusActionsCompleted}/${data.bonusActionsTotal} complétées`);
console.log(data.actions);

python

import requests

# Par ID de participation
entry_id = "entry_abc123"
response = requests.get(
    f"https://blitzrocket.com/api/v1/entries/{entry_id}/bonus-actions",
    headers={"x-api-key": "your_api_key_here"}
)

data = response.json()["data"]
print(f"{data['bonusActionsCompleted']}/{data['bonusActionsTotal']} complétées")
print(data["actions"])

Réponse

json

{
  "success": true,
  "data": {
    "entryId": "entry_abc123",
    "email": "jane@example.com",
    "totalPoints": 150,
    "bonusActionsCompleted": 2,
    "bonusActionsTotal": 5,
    "bonusPointsEarned": 30,
    "actions": [
      {
        "id": "ba_001",
        "action": "follow_twitter",
        "description": "Suivez-nous sur Twitter",
        "icon": "twitter",
        "iconColor": "#1DA1F2",
        "points": 10,
        "confirmationType": "auto",
        "destinationUrl": "https://twitter.com/blitzrocket",
        "order": 1,
        "completed": true,
        "completedAt": "2025-06-15T12:00:00.000Z",
        "completionStatus": "verified"
      },
      {
        "id": "ba_002",
        "action": "share_referral",
        "description": "Partagez votre lien de parrainage",
        "icon": "share",
        "iconColor": "#10B981",
        "points": 20,
        "confirmationType": "manual",
        "destinationUrl": null,
        "order": 2,
        "completed": true,
        "completedAt": "2025-06-16T09:30:00.000Z",
        "completionStatus": "verified"
      },
      {
        "id": "ba_003",
        "action": "visit_website",
        "description": "Visitez notre page produit",
        "icon": "link",
        "iconColor": "#6366F1",
        "points": 5,
        "confirmationType": "click",
        "destinationUrl": "https://example.com/product",
        "order": 3,
        "completed": false,
        "completedAt": null,
        "completionStatus": null
      }
    ]
  }
}

Champs de réponse

entryIdstring

L'identifiant de la participation

emailstring

Email du participant

totalPointsnumber

Nombre total de points pour la participation

bonusActionsCompletednumber

Nombre d'actions bonus complétées

bonusActionsTotalnumber

Nombre total d'actions bonus disponibles

bonusPointsEarnednumber

Points gagnés grâce aux actions bonus

actions[].idstring

Identifiant unique de l'action bonus

actions[].actionstring

Identifiant du type d'action

actions[].pointsnumber

Points attribués pour avoir complété cette action

actions[].completedboolean

Indique si cette action a été complétée

Compléter une Action Bonus

POST/api/v1/entries/:entryId/bonus-actions/:bonusActionId/complete

Public or Private API Key

Marquer une action bonus comme complétée pour une participation et attribuer les points associés.

Paramètres de chemin

entryIdstring required

L'identifiant unique de la participation

bonusActionIdstring required

L'identifiant unique de l'action bonus

Corps de la requête

proofstring

Preuve de complétion (optionnel, par exemple URL d'une capture d'écran)

answerstring

Réponse pour les actions bonus de type quiz (optionnel)

Request

bash

curl -X POST https://blitzrocket.com/api/v1/entries/entry_abc123/bonus-actions/ba_003/complete \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

javascript

const entryId = "entry_abc123";
const bonusActionId = "ba_003";
const response = await fetch(
  `https://blitzrocket.com/api/v1/entries/${entryId}/bonus-actions/${bonusActionId}/complete`,
  {
    method: "POST",
    headers: {
      "x-api-key": "your_api_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({}),
  }
);

const { data } = await response.json();
if (data.alreadyCompleted) {
  console.log("L'action a déjà été complétée");
} else {
  console.log(`+${data.pointsAdded} points ! Nouveau total : ${data.newTotalPoints}`);
}

python

import requests

entry_id = "entry_abc123"
bonus_action_id = "ba_003"
response = requests.post(
    f"https://blitzrocket.com/api/v1/entries/{entry_id}/bonus-actions/{bonus_action_id}/complete",
    headers={
        "x-api-key": "your_api_key_here",
        "Content-Type": "application/json"
    },
    json={}
)

data = response.json()["data"]
if data["alreadyCompleted"]:
    print("L'action a déjà été complétée")
else:
    print(f"+{data['pointsAdded']} points ! Nouveau total : {data['newTotalPoints']}")

Response (Nouvelle complétion)

json

{
  "success": true,
  "data": {
    "alreadyCompleted": false,
    "completedAt": "2025-06-17T14:00:00.000Z",
    "pointsAdded": 5,
    "newTotalPoints": 155,
    "message": "Action bonus complétée avec succès."
  }
}

Response (Déjà complétée)

json

{
  "success": true,
  "data": {
    "alreadyCompleted": true,
    "completedAt": "2025-06-15T12:00:00.000Z",
    "message": "Cette action bonus a déjà été complétée."
  }
}

Réponses d'erreur

Statut	Erreur	Description
`400`	entryId ou bonusActionId manquant	Les deux paramètres de chemin sont requis
`401`	Clé API invalide	La clé API est manquante ou invalide
`404`	Entrée ou action bonus non trouvée	La ressource spécifiée n'existe pas