Ihr Arbeitsbereich. Ihre API.

Workspace verbinden

1. Erstellen Sie ein Kundenprojekt im Dashboard. Kopieren Sie seine Projekt-UUID.
2. Bestätigen Sie Ihre E-Mail. In API & Webhooks können Inhaber oder Administratoren einen API-Schlüssel mit begrenzten Berechtigungen erstellen.
3. Speichern Sie den Schlüssel in einer Server-Umgebungsvariable namens INDEXTOAST_API_KEY. Verwenden Sie ihn niemals im Browsercode oder in einer URL.

curl https://api.indextoast.com/v1/business/usage \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY"

curl https://api.indextoast.com/v1/business/projects \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY"

Schlüssel laufen ab und können widerrufen werden. Änderungen an Workspace, Projekten, Schlüsseln, Webhooks und Abrechnung erfordern eine autorisierte Dashboard-Sitzung. API-Schlüssel können keine Abrechnung verwalten.

Standard

URLs zur Standard-Indexierung einreichen. Jede eindeutige URL verbraucht 1 Standard-Aktion.

curl https://api.indextoast.com/v1/business/batches/review \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "projectId": "YOUR_PROJECT_UUID",
  "name": "Client campaign",
  "operation": "standard",
  "urls": [
    "https://example.com/page-one",
    "https://example.com/page-two"
  ],
  "idempotencyKey": "campaign-standard-001"
}'

curl https://api.indextoast.com/v1/business/batches \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "projectId": "YOUR_PROJECT_UUID",
  "name": "Client campaign",
  "operation": "standard",
  "urls": [
    "https://example.com/page-one",
    "https://example.com/page-two"
  ],
  "idempotencyKey": "campaign-standard-001"
}'

Verwenden Sie 1–1.000 öffentliche HTTP(S)-URLs, eine Projekt-UUID aus Ihrem Workspace, einen Namen mit 1–100 Zeichen und einen Idempotenzschlüssel mit 8–150 Zeichen. Doppelte normalisierte URLs eines Stapels werden nur einmal berechnet.

{
  "id": "BATCH_UUID",
  "operation": "standard",
  "quantity": 2,
  "status": "queued",
  "successful": 0,
  "failed": 0,
  "results": []
}

202 bedeutet zur Verarbeitung angenommen. Es bestätigt weder Indexierung noch Abschlusszeit. Kapazität wird bei Annahme einmal abgebucht.

Index Checker

Prüfen Sie, ob URLs im Suchindex gefunden werden. Jede eindeutige URL verbraucht 1 Standard-Aktion, auch bei unklarem Ergebnis.

curl https://api.indextoast.com/v1/business/batches/review \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "projectId": "YOUR_PROJECT_UUID",
  "name": "Client campaign",
  "operation": "check",
  "urls": [
    "https://example.com/page-one",
    "https://example.com/page-two"
  ],
  "idempotencyKey": "campaign-check-001"
}'

curl https://api.indextoast.com/v1/business/batches \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "projectId": "YOUR_PROJECT_UUID",
  "name": "Client campaign",
  "operation": "check",
  "urls": [
    "https://example.com/page-one",
    "https://example.com/page-two"
  ],
  "idempotencyKey": "campaign-check-001"
}'

Verwenden Sie 1–1.000 öffentliche HTTP(S)-URLs, eine Projekt-UUID aus Ihrem Workspace, einen Namen mit 1–100 Zeichen und einen Idempotenzschlüssel mit 8–150 Zeichen. Doppelte normalisierte URLs eines Stapels werden nur einmal berechnet.

{
  "id": "BATCH_UUID",
  "operation": "check",
  "quantity": 2,
  "status": "queued",
  "successful": 0,
  "failed": 0,
  "results": []
}

202 bedeutet zur Verarbeitung angenommen. Es bestätigt weder Indexierung noch Abschlusszeit. Kapazität wird bei Annahme einmal abgebucht.

Index-Checker-Ergebnisse

{
  "results": [
    {
      "url": "https://example.com/page-one",
      "result": "indexed"
    },
    {
      "url": "https://example.com/page-two",
      "result": "unknown"
    }
  ]
}

indexed = gefunden; not_indexed = bei dieser Prüfung nicht gefunden; unknown = unklar. Ein abgeschlossener Stapel beschreibt die Verarbeitung, kein positives Indexergebnis. Prüfen Sie jedes URL-Ergebnis.

Boost

Boost kostet 20 gemeinsame Business-Einheiten pro eindeutiger URL.

curl https://api.indextoast.com/v1/business/batches/review \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "projectId": "YOUR_PROJECT_UUID",
  "name": "Client campaign",
  "operation": "boost",
  "urls": [
    "https://example.com/page-one",
    "https://example.com/page-two"
  ],
  "idempotencyKey": "campaign-boost-001"
}'

curl https://api.indextoast.com/v1/business/batches \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "projectId": "YOUR_PROJECT_UUID",
  "name": "Client campaign",
  "operation": "boost",
  "urls": [
    "https://example.com/page-one",
    "https://example.com/page-two"
  ],
  "idempotencyKey": "campaign-boost-001"
}'

Verwenden Sie 1–1.000 öffentliche HTTP(S)-URLs, eine Projekt-UUID aus Ihrem Workspace, einen Namen mit 1–100 Zeichen und einen Idempotenzschlüssel mit 8–150 Zeichen. Doppelte normalisierte URLs eines Stapels werden nur einmal berechnet.

{
  "id": "BATCH_UUID",
  "operation": "boost",
  "quantity": 2,
  "status": "queued",
  "successful": 0,
  "failed": 0,
  "results": []
}

202 bedeutet zur Verarbeitung angenommen. Es bestätigt weder Indexierung noch Abschlusszeit. Kapazität wird bei Annahme einmal abgebucht.

Verwenden Sie monatliche oder vorausbezahlte Business-Einheiten für Boost. Es gibt kein separates Boost-Kontingent.

Stapel verfolgen

curl https://api.indextoast.com/v1/business/batches/BATCH_UUID \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY"

curl https://api.indextoast.com/v1/business/batches?page=1 \
  -H "Authorization: Bearer $INDEXTOAST_API_KEY"

Listen enthalten 20 Stapel pro Seite. Prüfen Sie hasMore, bevor Sie die nächste Seite abrufen. Statusabfragen sind kostenlos; fragen Sie mit zunehmenden Abständen ab oder nutzen Sie einen Webhook.

queued → submitting → submitted / processing → completed
                                             ↘ failed / unknown

failed oder unknown erfordert Prüfung. Kontaktieren Sie den Support mit der Stapel-ID, bevor Sie einen Ersatz erstellen. Ein neuer Schlüssel kann erneut Kapazität abbuchen. Verarbeitungswiederholungen nutzen die ursprüngliche Reservierung.

Webhook-Signaturen prüfen

Konfigurieren Sie einen HTTPS-Endpunkt in API & Webhooks. Speichern Sie das einmal angezeigte Geheimnis. Empfangen Sie signierte batch.finished-Ereignisse und entfernen Sie Duplikate anhand der Ereignis-ID.

x-indextoast-signature: t=TIMESTAMP,v1=HEX

HMAC-SHA256(secret, timestamp + "." + rawBody)

• Prüfen Sie den unveränderten Nachrichtentext vor der Verarbeitung mit einem zeitkonstanten Vergleich.
• Lehnen Sie Zeitstempel ab, die mehr als fünf Minuten von Ihrer Serverzeit abweichen, auch zukünftige.
• Speichern Sie die Ereignis-ID vor der 2xx-Bestätigung. Zustellversuche sind begrenzt. Gleichen Sie verpasste Ereignisse über Stapelstatusabfragen ab.

Nutzung & Abrechnung

100 Standard-URLs mit je einer Prüfung kosten 200 Einheiten. 100 Boost-URLs kosten 2.000 Einheiten; je eine Prüfung kostet zusätzlich 100, insgesamt 2.100.

{
  "plan": "agency",
  "included": 10000,
  "purchased": 0,
  "standardAvailable": 10000,
  "boostAvailable": 500,
  "unitCosts": {
    "standard": 1,
    "check": 1,
    "boost": 20
  },
  "monthlyActionLimit": null,
  "acceptedThisMonth": 0,
  "periodEnd": "2026-11-08T00:00:00.000Z"
}

Inklusive Standard-Aktionen werden vor gekauften Aktionen verwendet. Sie werden zum bezahlten Abrechnungszeitraum ohne Übertrag erneuert. Vorausbezahlte Guthaben verfallen nicht. Regular- und Business-Guthaben sind getrennt.

Das monatliche Aktionslimit zählt alle angenommenen Vorgänge im UTC-Kalendermonat. Leer bedeutet Guthabenlimit; 0 pausiert neue Aufträge. Es ist ein Aktionslimit, kein Geldbudget.

Fehler und Wiederholungen

Wiederholen Sie eine Einreichung nach Zeitüberschreitung mit identischen Daten und demselben Idempotenzschlüssel. Der bestehende Stapel wird ohne erneute Abbuchung zurückgegeben. Der optionale Idempotency-Key-Header muss dem Nachrichtentext entsprechen.

API-Limit: 120 Anfragen pro Minute und Aufrufer-IP, gemeinsam für alle Routen. Validierung, Vorschau und Statusabfragen verbrauchen keine Aktionen. Ein kostenpflichtiges Index-Checker-Ergebnis kann dennoch unklar sein.