REST API Dokumentation
Erstelle leistungsstarke Integrationen mit TesterPayKits RESTful API. Vollständiger Zugriff auf Kampagnen, Bug-Reports, Tester und Analytik.
Basis-URL
https://api.testerpaykit.com Aktuelle Version
v1 (stabil) # Authentifizierung
API-Schlüssel-Authentifizierung
Alle API-Anfragen erfordern Authentifizierung mit einem API-Schlüssel. Gib deinen Schlüssel im
Authorization Header an.
# API-Schlüssel im Authorization-Header einfügen curl -X GET https://api.testerpaykit.com/v1/campaigns \ -H "Authorization: Bearer tpk_live_your_api_key" \ -H "Content-Type: application/json"
Halte deinen API-Schlüssel sicher
Lege deinen API-Schlüssel niemals in Client-seitigem Code oder öffentlichen Repositories offen. Verwende Umgebungsvariablen, um sensible Zugangsdaten zu speichern.
API-Schlüssel-Typen
tpk_live_... Produktions-API-Schlüssel. Alle Vorgänge beeinflussen echte Daten und Abrechnung.
tpk_test_... Sandbox-API-Schlüssel. Sicher für Entwicklung und Tests ohne Gebühren.
# Endpunkte
/v1/campaigns Alle Test-Kampagnen auflisten
stable/v1/campaigns Neue Test-Kampagne erstellen
stable/v1/campaigns/:id Kampagnendetails und Status abrufen
stable/v1/bugs Bug-Reports mit Filtern auflisten
stable/v1/bugs/:id Bug-Status oder Lösung aktualisieren
stable/v1/webhooks Webhook-Endpunkt registrieren
stable/v1/testers Verfügbare Tester auflisten
beta/v1/analytics Kampagnen-Analytik und Metriken
beta# Request- und Response-Format
Request-Beispiel
POST /v1/campaigns
Content-Type: application/json
Authorization: Bearer tpk_live_...
{
"name": "iOS Login Test",
"platform": "ios",
"testersRequired": 5,
"rewardPerBug": 4.00
} Response-Beispiel
{
"success": true,
"data": {
"id": "camp_abc123",
"name": "iOS Login Test",
"status": "draft",
"createdAt": "2026-01-27T..."
}
} # Fehlerbehandlung
Die API verwendet Standard-HTTP-Statuscodes, um Erfolg oder Fehler anzuzeigen. Fehlerantworten enthalten einen maschinenlesbaren Code und eine benutzerfreundliche Nachricht.
{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or expired",
"status": 401
}
} Erfolg
Ungültige Anfrage
Nicht autorisiert
Serverfehler
# Rate Limits
API-Anfragen sind Rate-limitiert, um faire Nutzung sicherzustellen. Rate-Limit-Informationen sind in Response-Headern enthalten.
Anfragen pro Minute
Anfragen pro Stunde
Anfragen pro Tag
# Rate-Limit-Header in der Response X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 987 X-RateLimit-Reset: 1706367600
Bevorzugst du ein SDK?
Unsere SDKs kümmern sich um Authentifizierung, Fehlerbehandlung und Rate Limiting für dich. Verfügbar für Flutter/Dart, TypeScript und Python.