Dokumentacja dla deweloperów

Asynchroniczne partie żądań API

Dodawaj wiele obsługiwanych żądań API do kolejki i odbieraj ich wyniki bez utrzymywania otwartego połączenia klienta.

Asynchroniczne partie żądań API

Dodawaj wiele obsługiwanych żądań API do kolejki i odbieraj ich wyniki bez utrzymywania otwartego połączenia klienta.

POST /v1/batches

Jak działa przetwarzanie partiami

Każda partia może zawierać do 100 obsługiwanych publicznych żądań GET.
Każdy element zachowuje standardową cenę swojego endpointu, a kredyty za ostatecznie nieudane elementy są zwracane niezależnie.
Stan zadania i wyniki pozostają dostępne dla wszystkich członków konta przez 24 godziny.
Opcjonalny webhook HTTPS może powiadomić Twój system, gdy przetwarzanie osiągnie stan końcowy.

Przykład Request

curl -X POST "https://domscan.net/v1/batches" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -H "Idempotency-Key: customer-import-42" \
  -H "Content-Type: application/json" \
  -d '{
    "requests": [
      {"path": "/v1/status", "query": {"domain": "example.com"}},
      {"path": "/v1/dns", "query": {"domain": "example.org", "type": "MX"}}
    ]
  }'

Odpowiedź Fields

Pole	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

Example Odpowiedź

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

Odpytywanie i anulowanie

Odpytuj endpoint stanu, pobieraj uporządkowane wyniki lub anuluj zadania, które jeszcze się nie rozpoczęły.

GET /v1/batches/{job_id}
GET /v1/batches/{job_id}/results
GET /v1/batches/{job_id}/results?format=csv
DELETE /v1/batches/{job_id}

Podpisane webhooki zakończenia

Podpisy webhooków używają HMAC-SHA256 dla znacznika czasu, kropki i dokładnej treści żądania. Przed przyjęciem dostarczenia zweryfikuj znacznik czasu.

X-DomScan-Event: batch.completed
X-DomScan-Timestamp: 1785231000
X-DomScan-Signature: sha256=...

POST /v1/domain-discovery/jobs

Parametry treści

Parametr	Typ	wymagane
tlds	string[]	wymagane
limit	integer	opcjonalne
cursor	string	opcjonalne
min_length	integer Domyślnie `3`	opcjonalne
max_length	integer Domyślnie `16`	opcjonalne
singular_only	boolean Domyślnie `false`	opcjonalne

Odpowiedź Fields

Pole	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
`discovery`	object
`discovery.corpus`	string
`discovery.corpus_version`	string
`discovery.total_matching_words`	integer
`discovery.page_offset`	integer
`discovery.page_words`	integer
`discovery.domain_checks`	integer
`discovery.tlds[]`	string[]
`discovery.filters`	object
`discovery.filters.min_length`	integer
`discovery.filters.max_length`	integer
`discovery.filters.singular_only`	boolean
`discovery.credits_per_domain`	integer
`discovery.next_cursor`	string \| null

Przykład Request

curl -X POST "https://domscan.net/v1/domain-discovery/jobs" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "tlds": [
    "io",
    "ai"
  ],
  "limit": 50,
  "min_length": 4,
  "max_length": 8,
  "singular_only": true
}'

Example Odpowiedź

{
  "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"
  },
  "discovery": {
    "corpus": "iannuttall/unclaimed",
    "corpus_version": "string",
    "total_matching_words": 1,
    "page_offset": 1,
    "page_words": 1,
    "domain_checks": "example.com",
    "tlds": [
      "string"
    ],
    "filters": {
      "min_length": 1,
      "max_length": 1,
      "singular_only": true
    },
    "credits_per_domain": "example.com",
    "next_cursor": "string"
  }
}

GET /v1/batches

Parametry zapytania

Parametr	Typ	wymagane
limit	integer Domyślnie `25`	opcjonalne

Odpowiedź Fields

Pole	Typ
`jobs[]`	object[]
`jobs[]`	object
`jobs[].id`	string
`jobs[].status`	string
`jobs[].total`	integer
`jobs[].counts`	object
`jobs[].counts.pending`	integer
`jobs[].counts.processing`	integer
`jobs[].counts.succeeded`	integer
`jobs[].counts.failed`	integer
`jobs[].counts.cancelled`	integer
`jobs[].billing`	object
`jobs[].billing.credits_charged`	integer
`jobs[].billing.credits_refunded`	integer
`jobs[].billing.credits_net`	integer
`jobs[].webhook`	object
`jobs[].webhook.configured`	boolean
`jobs[].webhook.status`	string
`jobs[].webhook.attempts`	integer
`jobs[].status_url`	string
`jobs[].results_url`	string
`jobs[].results_csv_url`	string
`jobs[].poll_after_ms`	integer \| null
`jobs[].created_at`	string
`jobs[].started_at`	string \| null
`jobs[].completed_at`	string \| null
`jobs[].cancelled_at`	string \| null
`jobs[].updated_at`	string
`jobs[].processing_deadline_at`	string
`jobs[].results_expires_at`	string
`retention_hours`	integer

Przykład Request

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/batches?limit=25"

Example Odpowiedź

{
  "jobs": [
    {
      "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"
    }
  ],
  "retention_hours": 24
}

GET /v1/batches/:job_id

Odpowiedź Fields

Pole	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

Przykład Request

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/batches/example.com"

Example Odpowiedź

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

GET /v1/batches/:job_id/results

Parametry zapytania

Parametr	Typ	wymagane
job_id	string	wymagane
after	integer Domyślnie `-1`	opcjonalne
limit	integer Domyślnie `100`	opcjonalne
format	string Dozwolone wartości `jsoncsv` Domyślnie `json`	opcjonalne

Odpowiedź Fields

Pole	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
`results[]`	object[]
`results[]`	object
`results[].position`	integer
`results[].reference`	string \| null
`results[].request`	object
`results[].request.method`	string
`results[].request.path`	string
`results[].request.query`	object
`results[].status`	string
`results[].attempts`	integer
`results[].http_status`	integer \| null
`results[].result`	object \| null
`results[].error`	object \| null
`results[].billing`	object
`results[].started_at`	string \| null
`results[].completed_at`	string \| null
`next_after`	integer \| null

Przykład Request

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/batches/example.com/results?after=example.com&limit=25&format=example.com"

Example Odpowiedź

{
  "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"
  },
  "results": [
    {
      "position": 1,
      "reference": "string",
      "request": {
        "method": "GET",
        "path": "string",
        "query": {}
      },
      "status": "pending",
      "attempts": 1,
      "http_status": 1,
      "result": {},
      "error": {},
      "billing": {},
      "started_at": "2026-04-15T12:00:00Z",
      "completed_at": "2026-04-15T12:00:00Z"
    }
  ],
  "next_after": 1
}

DELETE /v1/batches/:job_id

Odpowiedź Fields

Pole	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

Przykład Request

curl -X DELETE "https://domscan.net/v1/batches/example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'

Example Odpowiedź

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