مرجع API

API الخاص بـ حل الهوية على الإنترنت

حوّل نطاق شركة إلى هويات عامة يعلن عنها موقعها الإلكتروني صراحةً. استخدم هذا المرجع لاختيار نقطة النهاية المناسبة ومعرفة ما تعيده بالضبط.

العمليات

GET /v1/identity-resolution عرض مرجع API
POST /v1/identity-resolution/bulk عرض مرجع API

GET /v1/identity-resolution

العملية: resolveInternetIdentity الوحدات والمصادقة: 2 المصادقة مطلوبة
GET /v1/identity-resolution الرصيد: 2

معاملات الاستعلام

المعامل النوع مطلوب
domain string مطلوب
skip_cache string
القيم المسموحة 1
اختياري

حقول الرد

الحقل النوع
cache_age_s integer
query string
canonical_domain string
website_url string
fetch_state string
organization object
organization.name string | null
organization.description string | null
identities[] object[]
identities[] object
identities[].platform string
identities[].type string
identities[].handle string | null
identities[].url string
identities[].source string
identities[].confidence string
contacts object
contacts.emails[] string[]
contacts.phones[] string[]
confidence number
evidence object
evidence.declared_identity_count integer
evidence.high_confidence_count integer
evidence.medium_confidence_count integer
evidence.sources[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string
meta.fetch_error string

طلب مثال

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/identity-resolution?domain=example.com&skip_cache=1"
const response = await fetch("https://domscan.net/v1/identity-resolution?domain=example.com&skip_cache=1", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/identity-resolution?domain=example.com&skip_cache=1",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/identity-resolution?domain=example.com&skip_cache=1", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	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/identity-resolution?domain=example.com&skip_cache=1")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

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))

مثال الرد

{
  "query": "example",
  "canonical_domain": "example.com",
  "website_url": "https://example.com",
  "fetch_state": "ok",
  "organization": {
    "name": "example",
    "description": "example"
  },
  "identities": [
    {
      "platform": "github",
      "type": "social",
      "url": "https://example.com",
      "source": "same_as",
      "confidence": "high",
      "handle": "example"
    }
  ],
  "contacts": {
    "emails": [
      "[email protected]",
      "[email protected]"
    ],
    "phones": [
      "example"
    ]
  },
  "confidence": 0.85,
  "evidence": {
    "declared_identity_count": 1,
    "high_confidence_count": 1,
    "medium_confidence_count": 1,
    "sources": [
      "example"
    ]
  },
  "meta": {
    "checked_at": "2026-08-27T12:00:00Z",
    "cached": false,
    "fetch_transport": "worker",
    "fetch_error": "timeout"
  },
  "cache_age_s": 1
}

رموز حالة HTTP

  • 200 OK
  • 400 طلب غير صالح
  • 401 غير مصرح
  • 402 الدفع مطلوب
  • 429 طلبات كثيرة جداً
  • 502 بوابة غير صالحة

POST /v1/identity-resolution/bulk

العملية: bulkResolveInternetIdentity الوحدات والمصادقة: 2 المصادقة مطلوبة
POST /v1/identity-resolution/bulk الرصيد: 2/item

معاملات الاستعلام

المعامل النوع مطلوب
dry_run string
القيم المسموحة true
اختياري

معاملات متن الطلب

المعامل النوع مطلوب
domains string[] مطلوب

حقول الرد

الحقل النوع
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.type string
results[].error.error.message string
results[].error.error.status integer
results[].error.error.retryable boolean
results[].error.error.request_id string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.unknown integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

طلب مثال

curl -X POST "https://domscan.net/v1/identity-resolution/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domains": [
    "stripe.com",
    "github.com"
  ]
}'
const response = await fetch("https://domscan.net/v1/identity-resolution/bulk", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "domains": [
      "stripe.com",
      "github.com"
    ]
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/identity-resolution/bulk",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "domains": [
            "stripe.com",
            "github.com",
        ],
    },
)
print(response.json())
package main

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

func main() {
	body := strings.NewReader(`{
	  "domains": [
	    "stripe.com",
	    "github.com"
	  ]
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/identity-resolution/bulk", 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/identity-resolution/bulk")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "domains" => [
    "stripe.com",
    "github.com"
  ]
})

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))

مثال الرد

{
  "results": [
    {
      "input": "example",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "type": "authentication_error",
          "message": "Invalid domain format",
          "status": 400,
          "retryable": false,
          "request_id": "request-id",
          "docs_url": "https://domscan.net/docs/check-availability",
          "suggestion": "example",
          "details": {},
          "retry_after": 300
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "unknown": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}

رموز حالة HTTP

  • 200 OK
  • 400 طلب غير صالح
  • 401 غير مصرح
  • 402 الدفع مطلوب
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 طلبات كثيرة جداً

موارد المرجع