Dokumentacja dla deweloperów

Przepis uruchomienia marki

DomScan API do analizy domen: Lista kontrolna przed uruchomieniem dla domen marki, w tym DNS, SSL, uwierzytelnianie poczty e-mail i dostępność uchwytu społecznego.

Przepis uruchomienia marki

Lista kontrolna przed uruchomieniem dla domen marki, w tym DNS, SSL, uwierzytelnianie poczty e-mail i dostępność uchwytu społecznego.

GET /v1/recipes/brand-launch

Parametry zapytania

Parametr	Typ	Opis
domain wymagane	string	Domena do sprawdzenia gotowości uruchomienia
brand_name opcjonalne	string	Handle do sprawdzenia na platformach społecznościowych. Domyślnie to etykieta domeny.
platforms opcjonalne	string Domyślnie `twitter,github,reddit`	Platformy społecznościowe oddzielone przecinkami do sprawdzenia, do 10. Nieznane nazwy są ignorowane.

Odpowiedź zawiera

Status konfiguracji DNS
Walidacja certyfikatu SSL
Uwierzytelnianie poczty e-mail (SPF, DKIM, DMARC)
Dostępność uchwytu społecznego
Analiza oceny marki

Odpowiedź Fields

Pole	Typ
`success`	boolean
`data`	object
`data.domain`	string
`data.brand_name`	string
`data.readiness_score`	number
`data.status`	string
`data.checklist`	object
`data.checklist.domain_controlled`	object
`data.checklist.domain_controlled.name`	string
`data.checklist.domain_controlled.status`	string
`data.checklist.domain_controlled.details`	string
`data.checklist.ssl_configured`	object
`data.checklist.ssl_configured.name`	string
`data.checklist.ssl_configured.status`	string
`data.checklist.ssl_configured.details`	string
`data.checklist.dns_configured`	object
`data.checklist.dns_configured.name`	string
`data.checklist.dns_configured.status`	string
`data.checklist.dns_configured.details`	string
`data.checklist.email_auth`	object
`data.checklist.email_auth.name`	string
`data.checklist.email_auth.status`	string
`data.checklist.email_auth.score`	number
`data.checklist.email_auth.details`	string
`data.checklist.email_auth.action`	string
`data.checklist.social_handles`	object
`data.checklist.social_handles.name`	string
`data.checklist.social_handles.status`	string
`data.checklist.social_handles.score`	number
`data.checklist.social_handles.details`	string
`data.checklist.brand_protection`	object
`data.checklist.brand_protection.name`	string
`data.checklist.brand_protection.status`	string
`data.checklist.brand_protection.score`	number
`data.checklist.brand_protection.details`	string
`data.checklist.reputation_clean`	object
`data.checklist.reputation_clean.name`	string
`data.checklist.reputation_clean.status`	string
`data.checklist.reputation_clean.details`	string
`data.checklist.brand_quality`	object
`data.checklist.brand_quality.name`	string
`data.checklist.brand_quality.status`	string
`data.checklist.brand_quality.score`	number
`data.checklist.brand_quality.details`	string
`data.social_availability[]`	object[]
`data.social_availability[]`	object
`data.social_availability[].platform`	string
`data.social_availability[].available`	boolean
`data.social_availability[].url`	string
`data.typo_threats`	object
`data.typo_threats.total_variants`	number
`data.typo_threats.registered_threats`	number
`data.typo_threats.high_risk_count`	number
`data.brand_score`	object
`data.brand_score.overall`	number
`data.brand_score.pronounceability`	number
`data.brand_score.memorability`	number
`data.brand_score.spelling_ease`	number
`data.action_items[]`	object[]
`data.action_items[]`	object
`data.action_items[].priority`	string
`data.action_items[].category`	string
`data.action_items[].action`	string
`data.action_items[].details`	string
`data.action_items[].estimated_impact`	string
`meta`	object
`meta.recipe_name`	string
`meta.credits_used`	number
`meta.credits_saved`	number
`meta.duration_ms`	number
`meta.components_called[]`	string[]
`meta.cached_components[]`	array
`meta.timestamp`	string
`errors[]`	array

Example Odpowiedź

{
  "success": true,
  "data": {
    "domain": "launchbrand.com",
    "brand_name": "Launch Brand",
    "readiness_score": 82,
    "status": "ready",
    "checklist": {
      "domain_controlled": {
        "name": "Domain Ownership",
        "status": "pass",
        "details": "Domain is registered"
      },
      "ssl_configured": {
        "name": "SSL Certificate",
        "status": "pass",
        "details": "HTTPS is working"
      },
      "dns_configured": {
        "name": "DNS Configuration",
        "status": "pass",
        "details": "DNS records configured"
      },
      "email_auth": {
        "name": "Email Authentication",
        "status": "warning",
        "score": 66,
        "details": "Missing: DMARC",
        "action": "Configure DMARC"
      },
      "social_handles": {
        "name": "Social Handles",
        "status": "warning",
        "score": 50,
        "details": "2 of 4 handles available"
      },
      "brand_protection": {
        "name": "Brand Protection",
        "status": "warning",
        "score": 71,
        "details": "1 high-risk typo variant available"
      },
      "reputation_clean": {
        "name": "Reputation",
        "status": "pass",
        "details": "Clean reputation"
      },
      "brand_quality": {
        "name": "Brand Quality",
        "status": "pass",
        "score": 84,
        "details": "Strong memorability and spelling ease"
      }
    },
    "social_availability": [
      {
        "platform": "github",
        "available": true,
        "url": "https://github.com/launchbrand"
      },
      {
        "platform": "twitter",
        "available": false
      }
    ],
    "typo_threats": {
      "total_variants": 48,
      "registered_threats": 2,
      "high_risk_count": 1
    },
    "brand_score": {
      "overall": 84,
      "pronounceability": 80,
      "memorability": 86,
      "spelling_ease": 88
    },
    "action_items": [
      {
        "priority": "high",
        "category": "email",
        "action": "Configure DMARC",
        "details": "Complete the authentication trio before launch.",
        "estimated_impact": "Higher inbox placement"
      }
    ]
  },
  "meta": {
    "recipe_name": "brand-launch-readiness",
    "credits_used": 10,
    "credits_saved": 4,
    "duration_ms": 581,
    "components_called": [
      "availability",
      "health",
      "dns_security",
      "reputation",
      "typosquatting",
      "scoring",
      "social"
    ],
    "cached_components": [],
    "timestamp": "2026-04-15T09:42:00Z"
  },
  "errors": []
}