Référence API

API Score de Domaine

Obtenez une note de qualité complète pour un domaine basée sur plusieurs facteurs. Utilisez cette référence pour choisir une opération et intégrer son contrat de réponse documenté.

Opérations

GET /v1/score Voir la référence API
POST /v1/score/compare Voir la référence API
GET /v1/score/info Voir la référence API

GET /v1/score

Opération: getDomainScore Crédits et authentification: 1 Authentification requise
GET /v1/score

Paramètres de Requête

Paramètre Type requis
name string optionnel
domain string optionnel

Champs de Réponse

Champ Type
name string
overall_score integer
grade string
scores object
scores.length integer
scores.pronounceability number
scores.memorability integer
scores.spelling integer
scores.uniqueness integer
scores.brandability integer
score_explanation object
score_explanation.score_band string
score_explanation.top_strengths[] object[]
score_explanation.top_strengths[] object
score_explanation.top_strengths[].dimension string
score_explanation.top_strengths[].score number
score_explanation.top_strengths[].weight number
score_explanation.top_blockers[] object[]
score_explanation.top_blockers[] object
score_explanation.top_blockers[].dimension string
score_explanation.top_blockers[].score number
score_explanation.top_blockers[].weight number
score_explanation.weighted_dimensions object
score_explanation.most_sensitive_dimension string
score_explanation.points_to_next_grade integer | null
feedback[] string[]

Exemple de Requête

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/score?name=brandify&domain=example.com"

Exemple de Réponse

{
  "name": "string",
  "overall_score": 1,
  "grade": "string",
  "scores": {
    "length": 1,
    "pronounceability": 1,
    "memorability": 1,
    "spelling": 1,
    "uniqueness": 1,
    "brandability": 1
  },
  "score_explanation": {
    "score_band": "excellent",
    "top_strengths": [
      {
        "dimension": "string",
        "score": 1,
        "weight": 1
      }
    ],
    "top_blockers": [
      {
        "dimension": "string",
        "score": 1,
        "weight": 1
      }
    ],
    "weighted_dimensions": {},
    "most_sensitive_dimension": "string",
    "points_to_next_grade": 1
  },
  "feedback": [
    "string"
  ]
}

POST /v1/score/compare

Opération: compareBrandNames Crédits et authentification: 2 Authentification requise
POST /v1/score/compare

Paramètres du Corps

Paramètre Type requis
names string[] requis

Champs de Réponse

Champ Type
names[] object[]
names[] object
best string | null
ranking[] object[]
ranking[] object
ranking[].name string
ranking[].score number
ranking[].rank integer
decision_summary object
decision_summary.compared_count integer
decision_summary.best string | null
decision_summary.runner_up string | null
decision_summary.score_margin integer | null
decision_summary.score_spread integer
decision_summary.tie_breaker string | null
decision_summary.winning_dimension string | null
meta object
meta.total_compared integer
meta.valid_scores integer

Exemple de Requête

curl -X POST "https://domscan.net/v1/score/compare" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "names": [
    "brandify",
    "brandpilot",
    "brandmint"
  ]
}'

Exemple de Réponse

{
  "names": [
    {
      "name": "brandify",
      "score": 88,
      "grade": "A",
      "verdict": "Strong"
    },
    {
      "name": "brandpilot",
      "score": 82,
      "grade": "B+",
      "verdict": "Promising"
    }
  ],
  "best": "brandify",
  "ranking": [
    {
      "name": "brandify",
      "score": 88,
      "rank": 1
    },
    {
      "name": "brandpilot",
      "score": 82,
      "rank": 2
    }
  ],
  "decision_summary": {
    "compared_count": 2,
    "best": "brandify",
    "runner_up": "brandpilot",
    "score_margin": 6,
    "score_spread": 6,
    "tie_breaker": "higher_brandability",
    "winning_dimension": "brandability"
  },
  "meta": {
    "total_compared": 2,
    "valid_scores": 2
  }
}

GET /v1/score/info

Opération: getScoreInfo Crédits et authentification: Gratuit Authentification requise
GET /v1/score/info

Champs de Réponse

Champ Type
scoring_dimensions object
grade_scale object
endpoints object

Exemple de Requête

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/score/info"

Exemple de Réponse

{
  "scoring_dimensions": {
    "length": {
      "weight": 0.12,
      "description": "Rewards concise names"
    },
    "pronounceability": {
      "weight": 0.18,
      "description": "Rewards names that are easy to say"
    }
  },
  "grade_scale": {
    "A+": "Exceptional",
    "A": "Excellent",
    "B": "Good",
    "C": "Average",
    "D": "Weak",
    "F": "Poor"
  },
  "endpoints": {
    "GET /v1/score?name=<name>": "Score a single name",
    "POST /v1/score/compare": "Compare multiple names",
    "GET /v1/score/info": "Get scoring methodology"
  }
}

Ressources de référence