Övervakning och automatisering · DomScan-produkt

Asynkrona API-batchar API-referens

Köa många API-begäranden som stöds och samla in resultaten utan att hålla en klientanslutning öppen.

Det här får du

Köa många API-begäranden som stöds och samla in resultaten utan att hålla en klientanslutning öppen.

AsynkrontRESTMCPSDK

Välj denna produkt när

Vem är det till för?

Använd automatisering när samma beslut måste köras över tid, över en lista eller över flera produkter.

Välj denna produkt när

Välj detta för att köa upp till 100 stödda GET-förfrågningar och hämta JSON- eller CSV-resultat inom en lagringsperiod på 24 timmar.

Det här får du

Köa många API-begäranden som stöds och samla in resultaten utan att hålla en klientanslutning öppen.

Endpoints

Granska stödda operationer, indata, utdata, körningslägen och svarsbegränsningar innan du integrerar.

POST /v1/batches Visa API-referens
GET /v1/batches Visa API-referens
GET /v1/batches/:job_id Visa API-referens
GET /v1/batches/:job_id/results Visa API-referens
DELETE /v1/batches/:job_id Visa API-referens

Credits och autentisering

Gratis Autentisering krävs. Se operationsreferensen för exakt kostnad och eventuell prissättning per objekt.

Exempel på operation

Använd dokumenterade operationer för att samla in, bedöma, berika, verifiera, jämföra, skydda eller övervaka offentliga bevis.

POST /v1/batches

Brödtextparametrar

Parameter Typ obligatorisk
requests object[] obligatorisk
webhook object valfri

Svarsfält

Fält Typ
job object
job.id string
job.status string
job.total integer
job.counts object
job.counts.pending integer
job.counts.processing integer
job.counts.succeeded integer
job.counts.failed integer
job.counts.cancelled integer
job.billing object
job.billing.credits_charged integer
job.billing.credits_refunded integer
job.billing.credits_net integer
job.webhook object
job.webhook.configured boolean
job.webhook.status string
job.webhook.attempts integer
job.status_url string
job.results_url string
job.results_csv_url string
job.poll_after_ms integer | null
job.created_at string
job.started_at string | null
job.completed_at string | null
job.cancelled_at string | null
job.updated_at string
job.processing_deadline_at string
job.results_expires_at string

Exempelbegäran

curl -X POST "https://domscan.net/v1/batches" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "requests": [
    {
      "path": "/v1/status",
      "query": {
        "domain": "example.com"
      },
      "reference": "customer-42"
    },
    {
      "path": "/v1/dns",
      "query": {
        "domain": "example.org",
        "type": "MX"
      }
    }
  ],
  "webhook": {
    "url": "https://example.com/hooks/domscan",
    "secret": "replace-with-a-private-secret"
  }
}'

Exempelsvar

{
  "job": {
    "id": "string",
    "status": "queued",
    "total": 1,
    "counts": {
      "pending": 1,
      "processing": 1,
      "succeeded": 1,
      "failed": 1,
      "cancelled": 1
    },
    "billing": {
      "credits_charged": 1,
      "credits_refunded": 1,
      "credits_net": 1
    },
    "webhook": {
      "configured": true,
      "status": "not_configured",
      "attempts": 1
    },
    "status_url": "https://example.com",
    "results_url": "https://example.com",
    "results_csv_url": "https://example.com",
    "poll_after_ms": 1,
    "created_at": "2026-04-15T12:00:00Z",
    "started_at": "2026-04-15T12:00:00Z",
    "completed_at": "2026-04-15T12:00:00Z",
    "cancelled_at": "2026-04-15T12:00:00Z",
    "updated_at": "2026-04-15T12:00:00Z",
    "processing_deadline_at": "2026-04-15T12:00:00Z",
    "results_expires_at": "2026-04-15T12:00:00Z"
  }
}

Begränsningar och bevisgränser

Asynkrona jobb returnerar en identifierare för statuspollning och senare hämtning av resultat.
Bulkoperationer behandlar flera stödda indata och bevarar dokumenterade resultat per objekt.
Partiellt betyder att vissa begärda objekt eller komponenter slutfördes medan andra inte gjorde det.
Cachat innebär att lagrade bevis användes. Granska metadata för aktualitet när den finns.

Granskad 2026-08-22

Vanliga frågor

Var hittar jag request- och response-referensen för Asynkrona API-batchar?

Använd API-referensen för Asynkrona API-batchar för att granska parametrar, svarsfält, exempel, statuskoder och stödda körningslägen.

Hur ska jag tolka okända eller ofullständiga resultat från Asynkrona API-batchar?

Okända eller partiella resultat betyder att de begärda bevisen inte kunde fastställas helt. Behåll resultatstatus, konfidens, aktualitet och begränsningar i efterföljande beslut.

Hur prissätts Asynkrona API-batchar?

Priset beror på operation och körningsläge. Se endpointreferensen för aktuell creditkostnad, autentiseringskrav och regler per objekt.