Überwachung und Automatisierung · DomScan-Produkt

API für Asynchrone API-Stapel

Stellen Sie mehrere unterstützte API-Anfragen in eine Warteschlange und rufen Sie die Ergebnisse ab, ohne eine Clientverbindung offen zu halten.

Was Sie erhalten

Stellen Sie mehrere unterstützte API-Anfragen in eine Warteschlange und rufen Sie die Ergebnisse ab, ohne eine Clientverbindung offen zu halten.

AsynchronRESTMCPSDK

Wählen Sie dieses Produkt, wenn

Für wen es gedacht ist

Nutzen Sie Automatisierung, wenn dieselbe Entscheidung über die Zeit, über eine Liste oder über mehrere Produkte hinweg ausgeführt werden muss.

Wählen Sie dieses Produkt, wenn

Wählen Sie dies, um bis zu 100 unterstützte GET-Anfragen einzureihen und JSON- oder CSV-Ergebnisse innerhalb der 24-stündigen Aufbewahrung abzurufen.

Was Sie erhalten

Stellen Sie mehrere unterstützte API-Anfragen in eine Warteschlange und rufen Sie die Ergebnisse ab, ohne eine Clientverbindung offen zu halten.

Endpunkte

Sehen Sie vor der Integration, was jeder Endpunkt akzeptiert und zurückgibt, welche Modi und Limits er hat.

POST /v1/batches API-Referenz ansehen
GET /v1/batches API-Referenz ansehen
GET /v1/batches/:job_id API-Referenz ansehen
GET /v1/batches/:job_id/results API-Referenz ansehen
DELETE /v1/batches/:job_id API-Referenz ansehen
GET /v1/jobs API-Referenz ansehen
GET /v1/jobs/:job_id API-Referenz ansehen
GET /v1/jobs/:job_id/results API-Referenz ansehen
POST /v1/jobs/:job_id/cancel API-Referenz ansehen
POST /v1/estimate API-Referenz ansehen
POST /v1/feedback API-Referenz ansehen

Credits und Authentifizierung

Kostenlos Authentifizierung erforderlich. Die genauen Kosten, einschließlich eventueller Preise pro Element, finden Sie in der API-Referenz.

Beispieloperation

Nutzen Sie dokumentierte Operationen, um öffentliche Belege zu erfassen, zu bewerten, anzureichern, zu verifizieren, zu vergleichen, zu schützen oder zu überwachen.

POST /v1/batches Credits: 0

Body-Parameter

Parameter Typ erforderlich
notify_webhook unknown optional
requests object[] erforderlich
webhook object optional

Antwortfelder

Feld 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

Beispielanfrage

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"
  }
}'
const response = await fetch("https://domscan.net/v1/batches", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "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"
    }
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/batches",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "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",
        },
    },
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "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"
	  }
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/batches", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/batches")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "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"
  }
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))

Beispielantwort

{
  "job": {
    "id": "example-id",
    "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": false,
      "status": "not_configured",
      "attempts": 1
    },
    "status_url": "https://example.com",
    "results_url": "https://example.com",
    "results_csv_url": "https://example.com",
    "created_at": "2026-08-27T12:00:00Z",
    "updated_at": "2026-08-27T12:00:00Z",
    "processing_deadline_at": "2026-08-27T12:00:00Z",
    "results_expires_at": "2026-08-27T12:00:00Z",
    "poll_after_ms": 1,
    "started_at": "2026-08-27T12:00:00Z",
    "completed_at": "2026-08-27T12:00:00Z",
    "cancelled_at": "2026-08-27T12:00:00Z"
  }
}

HTTP-Statuscodes

  • 200 OK
  • 202 Akzeptiert
  • 400 Ungültige Anfrage
  • 401 Nicht autorisiert
  • 402 Zahlung erforderlich
  • 409 HTTP 409
  • 429 Zu viele Anfragen

Häufig gestellte Fragen

Wo finde ich die Request- und Response-Referenz für Asynchrone API-Stapel?

In der API-Referenz für Asynchrone API-Stapel finden Sie Parameter, Response-Felder, Beispiele, Statuscodes und unterstützte Operationsmodi.

Wie sollte ich unbekannte oder unvollständige Ergebnisse von Asynchrone API-Stapel interpretieren?

Unbekannt oder teilweise bedeutet, dass wir das Ergebnis nicht vollständig bestätigen konnten. Berücksichtigen Sie Status, Konfidenz, Aktualität und eventuelle Limits, wenn Sie darauf reagieren.

Wie wird Asynchrone API-Stapel abgerechnet?

Der Preis hängt von der Prüfung und vom gewählten Modus ab. Die API-Referenz zeigt die aktuellen Credit-Kosten, ob Sie einen API-Schlüssel brauchen und eventuelle Preise pro Element.

Wird von Mitarbeitenden dieser Unternehmen genutzt

InstantOutseerMongoDBRespondentSage Expense ManagementInstantlyD.R. HortonWhatConvertsAdobeLLM Pulse