API Reference

Bonusaktionen

Bonusaktionen für Wettbewerbseinträge abrufen und abschließen

Bonusaktionen

Bonusaktionen sind Aufgaben, die Teilnehmer abschließen können, um in einem Wettbewerb zusätzliche Punkte zu erhalten. Verwenden Sie diese Endpunkte, um verfügbare Bonusaktionen abzurufen und als abgeschlossen zu markieren.


Bonusaktionen abrufen

GET/api/v1/entries/:entryId/bonus-actions
Public or Private API Key

Alle Bonusaktionen für einen bestimmten Eintrag abrufen, einschließlich ihres Abschlussstatus.

Pfadparameter

entryIdstring required

Die eindeutige Eintrags-ID. Verwenden Sie 'lookup' mit Abfrageparametern, um per E-Mail zu suchen.

Abfrageparameter (wenn entryId "lookup" ist)

emailstring required

E-Mail-Adresse zur Suche

contestIdstring required

Wettbewerbs-ID, in der gesucht wird

Anfrage

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

# Nach E-Mail-Suche
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"

Antwort

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": "Folgen Sie uns auf 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": "Teilen Sie Ihren Empfehlungslink",
        "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": "Besuchen Sie unsere Produktseite",
        "icon": "link",
        "iconColor": "#6366F1",
        "points": 5,
        "confirmationType": "click",
        "destinationUrl": "https://example.com/product",
        "order": 3,
        "completed": false,
        "completedAt": null,
        "completionStatus": null
      }
    ]
  }
}

Antwortfelder

entryIdstring

Die Eintrags-ID

emailstring

E-Mail des Teilnehmers

totalPointsnumber

Gesamtpunktzahl für den Eintrag

bonusActionsCompletednumber

Anzahl der abgeschlossenen Bonusaktionen

bonusActionsTotalnumber

Gesamtanzahl der verfügbaren Bonusaktionen

bonusPointsEarnednumber

Punkte, die durch Bonusaktionen verdient wurden

actions[].idstring

Eindeutige Kennung der Bonusaktion

actions[].actionstring

Kennung des Aktionstyps

actions[].pointsnumber

Punkte, die für das Abschließen dieser Aktion vergeben werden

actions[].completedboolean

Ob diese Aktion abgeschlossen wurde


Bonusaktion abschließen

POST/api/v1/entries/:entryId/bonus-actions/:bonusActionId/complete
Public or Private API Key

Markieren Sie eine Bonusaktion für einen Eintrag als abgeschlossen und vergeben Sie die zugehörigen Punkte.

Pfadparameter

entryIdstring required

Die eindeutige Eintrags-ID

bonusActionIdstring required

Die eindeutige Bonusaktions-ID

Anfrageinhalt

proofstring

Nachweis des Abschlusses (optional, z. B. Screenshot-URL)

answerstring

Antwort für Quiz-artige Bonusaktionen (optional)

Anfrage

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 '{}'

Antwort (Neue Abschluss)

json
{
  "success": true,
  "data": {
    "alreadyCompleted": false,
    "completedAt": "2025-06-17T14:00:00.000Z",
    "pointsAdded": 5,
    "newTotalPoints": 155,
    "message": "Bonusaktion erfolgreich abgeschlossen."
  }
}

Antwort (Bereits abgeschlossen)

json
{
  "success": true,
  "data": {
    "alreadyCompleted": true,
    "completedAt": "2025-06-15T12:00:00.000Z",
    "message": "Diese Bonusaktion wurde bereits abgeschlossen."
  }
}

Fehlerantworten

StatusFehlerBeschreibung
400Fehlende entryId oder bonusActionIdBeide Pfadparameter sind erforderlich
401Ungültiger API-SchlüsselAPI-Schlüssel fehlt oder ist ungültig
404Eintrag oder Bonusaktion nicht gefundenDie angegebene Ressource existiert nicht