API-Dokumentation

Integrieren Sie Digital-Footprint-Prüfungen in Ihre Anwendung. Suchen Sie per REST-API nach E-Mail-Adressen, Telefonnummern, Benutzernamen und mehr.

API-Schlüssel abrufen Endpunkte ansehen

Basis-URL: https://api.digitalfootprintcheck.com

Auth-Header: Authorization: Basic key-YOUR_API_KEY

Ratenlimit: 5.000 Anfragen pro Stunde

Inhaltstyp: application/json

API-Schlüssel erhalten

Abonnieren Sie einen Pro- oder Business-Tarif
Gehen Sie im Dashboard zu Konto > API-Schlüssel
Klicken Sie auf Neuer API-Schlüssel und wählen Sie die benötigten Berechtigungen aus
Kopieren Sie Ihren Schlüssel (er beginnt mit key-)

Beispiel: Suche erstellen

cURL

curl -X POST https://api.digitalfootprintcheck.com/api/search \
  -H "Authorization: Basic key-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"identity":"example@gmail.com"}'

JavaScript

const res = await fetch('https://api.digitalfootprintcheck.com/api/search', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic key-YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ identity: 'example@gmail.com' })
});
const data = await res.json();
console.log(data.data.searchId);

Python

import requests

res = requests.post(
    'https://api.digitalfootprintcheck.com/api/search',
    headers={
        'Authorization': 'Basic key-YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={'identity': 'example@gmail.com'}
)
data = res.json()
print(data['data']['searchId'])

API-Endpunkte

POST/api/search

Startet eine Suche und gibt sofort eine searchId zurück. Fragen Sie GET /api/search/:id ab, bis complete den Wert true hat. Verbraucht 1 Credit.

Anfragetext

Feld	Typ	Beschreibung
identity	string	E-Mail, Telefonnummer, Benutzername oder vollständiger Name

Antwort (201)

{
  "data": {
    "searchId": "a1b2c3d4-...",
    "identity": "user@example.com",
    "complete": false,
    "paid": true
  }
}

GET/api/search/:id

Ergebnisse abfragen. Suchen sind in der Regel nach 15 bis 60 Sekunden abgeschlossen. Alle 3 Sekunden abfragen.

Antwort bei Abschluss (200)

{
  "data": {
    "searchId": "a1b2c3d4-...",
    "identity": "user@example.com",
    "complete": true,
    "report": { "employment": [...], ... }
  }
}

Abfragebeispiel (JavaScript)

async function pollUntilComplete(searchId) {
  while (true) {
    const res = await fetch(
      'https://api.digitalfootprintcheck.com/api/search/' + searchId,
      { headers: { Authorization: 'Basic key-YOUR_KEY' } }
    );
    const data = (await res.json()).data;
    if (data.complete) return data;
    await new Promise(r => setTimeout(r, 3000));
  }
}

GET/api/search

Listet alle Suchen Ihres Kontos auf, die neuesten zuerst.

GET/api/account

Kontodetails abrufen: Tarif, verbleibende Credits, Abo-Status.

GET/api/user

Profilinformationen des Benutzers abrufen.

GET/api/key

Listet alle API-Schlüssel auf (maskiert). Verwenden Sie GET /api/key/:id, um einen vollständigen Schlüssel anzuzeigen.

Fehlercodes

Status	Bedeutung
401	Ungültiger oder fehlender API-Schlüssel
402	Nicht genügend Credits – upgraden Sie Ihren Tarif
403	Der API-Schlüssel hat nicht die erforderliche Berechtigung
429	Ratenlimit überschritten – warten Sie und versuchen Sie es erneut
500	Serverfehler – kontaktieren Sie den Support, falls er bestehen bleibt

Bereit zum Entwickeln?

Abonnieren Sie einen Pro- oder Business-Tarif, erstellen Sie einen API-Schlüssel und starten Sie die Integration in wenigen Minuten.

Tarife ansehen API-Schlüssel verwalten