Uw werkruimte. Uw API.

Verbind uw werkruimte

1. Maak een klantproject in het dashboard. Kopieer de project-UUID.
2. Verifieer uw e-mail. Een eigenaar of beheerder kan in API en webhooks een API-sleutel met beperkte rechten maken.
3. Bewaar de sleutel in een serveromgevingsvariabele met de naam INDEXTOAST_API_KEY. Zet deze nooit in browsercode of een 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"

Sleutels verlopen en kunnen worden ingetrokken. Wijzigingen aan de werkruimte, projecten, sleutels, webhooks en facturering vereisen een bevoegde dashboardsessie. API-sleutels kunnen facturering niet beheren.

Standard

Dien URL’s in voor Standard-indexering. Elke unieke URL gebruikt 1 Standard-actie.

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

Gebruik 1–1.000 openbare HTTP(S)-URL’s, een project-UUID uit uw werkruimte, een naam van 1–100 tekens en een idempotentiesleutel van 8–150 tekens. Dubbele genormaliseerde URL’s binnen een batch worden één keer berekend.

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

202 betekent geaccepteerd voor verwerking. Het bevestigt geen indexering of voltooiingstijd. Capaciteit wordt bij acceptatie één keer afgeschreven.

Index Checker

Controleer of URL’s in de zoekindex worden gevonden. Elke unieke URL gebruikt 1 Standard-actie, ook bij een onduidelijk resultaat.

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

Gebruik 1–1.000 openbare HTTP(S)-URL’s, een project-UUID uit uw werkruimte, een naam van 1–100 tekens en een idempotentiesleutel van 8–150 tekens. Dubbele genormaliseerde URL’s binnen een batch worden één keer berekend.

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

202 betekent geaccepteerd voor verwerking. Het bevestigt geen indexering of voltooiingstijd. Capaciteit wordt bij acceptatie één keer afgeschreven.

Index Checker-resultaten

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

indexed = gevonden; not_indexed = niet gevonden bij deze controle; unknown = onduidelijk. Een voltooide batch beschrijft de verwerking, geen positief indexresultaat. Lees elk URL-resultaat.

Boost

Boost gebruikt 20 gedeelde Business-eenheden per unieke 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"
}'

Gebruik 1–1.000 openbare HTTP(S)-URL’s, een project-UUID uit uw werkruimte, een naam van 1–100 tekens en een idempotentiesleutel van 8–150 tekens. Dubbele genormaliseerde URL’s binnen een batch worden één keer berekend.

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

202 betekent geaccepteerd voor verwerking. Het bevestigt geen indexering of voltooiingstijd. Capaciteit wordt bij acceptatie één keer afgeschreven.

Gebruik maandelijkse of vooraf betaalde Business-eenheden voor Boost. Er is geen apart Boost-quotum.

Batches volgen

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"

Lijsten bevatten 20 batches per pagina. Lees hasMore voordat u de volgende pagina opvraagt. Statusopvragingen zijn gratis; gebruik oplopende intervallen of een webhook.

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

failed of unknown vereist beoordeling. Neem met de batch-ID contact op met support voordat u een vervanging maakt; een nieuwe sleutel kan opnieuw capaciteit afschrijven. Verwerkingspogingen gebruiken de oorspronkelijke reservering.

Webhookhandtekeningen controleren

Stel een HTTPS-endpoint in bij API en webhooks. Bewaar het eenmalig getoonde geheim. Ontvang ondertekende batch.finished-events en verwijder duplicaten op event-ID.

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

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

• Verifieer de onbewerkte berichtinhoud met een vergelijking in constante tijd vóór verwerking.
• Weiger tijdstempels die meer dan vijf minuten afwijken van uw serverklok, ook toekomstige.
• Sla de event-ID op voordat u met 2xx bevestigt. Bezorgpogingen zijn beperkt; controleer gemiste events via de batchstatus.

Gebruik en facturering

100 Standard-URLs met elk één controle kosten 200 eenheden. 100 Boost-URLs kosten 2.000 eenheden; elk één controle voegt 100 toe, in totaal 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"
}

Inbegrepen Standard-acties worden vóór gekochte acties gebruikt. Ze worden in de betaalde factureringsperiode zonder overdracht vernieuwd; vooraf betaald tegoed verloopt niet. Regular- en Business-tegoeden zijn gescheiden.

De maandlimiet telt alle geaccepteerde bewerkingen in de UTC-kalendermaand. Leeg gebruikt tegoedlimieten; 0 pauzeert nieuwe opdrachten. Dit is een actielimiet, geen geldbudget.

Fouten en opnieuw proberen

Herhaal een indiening na een time-out met dezelfde inhoud en idempotentiesleutel. De bestaande batch komt terug zonder nieuwe afschrijving. De optionele Idempotency-Key-header moet overeenkomen met de inhoud.

API-limiet: 120 verzoeken per minuut per IP, gedeeld tussen routes. Validatie, beoordeling en statusopvragingen gebruiken geen acties. Een betaald Index Checker-resultaat kan nog steeds onduidelijk zijn.