API de Monitor de Marca

Q: Quais endpoints estão incluídos?

Este guia cobre 7 endpoints públicos: GET /v1/brand-monitor , POST /v1/brand-monitor , POST /v1/brand-monitor/scan , GET /v1/brand-monitor/status , DELETE /v1/brand-monitor , POST /v1/brand-monitor/reset-baseline , PUT /v1/brand-monitor/alerts .

Categoria Monitoramento

Pontos finais 7

Créditos 1-6

Autenticação Autenticação necessária

Usado por pessoas em empresas incríveis

Sinais de confiança antes da integração

Documentação transparente, solicitações autenticadas e detalhes visíveis de confiabilidade facilitam avaliar o DomScan antes de publicar.

Ao vivo Status do serviço

Consulte o estado do serviço ao vivo e as respostas de falha documentadas antes de fazer a integração.

OpenAPI Artefatos da API

OpenAPI, Swagger, Postman, CLI, SDK e links MCP ficam a um clique.

Chaves API Acesso protegido

Endpoints autenticados usam chaves API com custos de créditos claros antes da chamada.

10,000 Cota gratuita

Comece com 10.000 créditos mensais e faça upgrade só quando o uso crescer.

O que esta API ajuda você a lançar

Use esta página como briefing de produção: endpoints, exemplos, formato da resposta e peças de workflow para conectar o DomScan ao seu produto.

Workflows de produto

Incorpore checagens de domínio, inteligência DNS, sinais de risco ou enriquecimento em onboarding, busca e ferramentas internas.

Automação de analistas

Substitua consultas manuais repetidas por jobs agendados, alertas e etapas de investigação reproduzíveis.

Dados JSON limpos

Use campos previsíveis, códigos de status documentados e custos em créditos em vez de raspar páginas de fornecedores.

IA e operações

Alimente agentes, dashboards, playbooks SOAR e CRMs via OpenAPI, SDK, Postman ou MCP.

Fluxo de integração

Um caminho simples da primeira requisição ao uso repetível em produção.

Autentique uma vez

Envie sua chave API com o cabeçalho documentado e mantenha requisições consistentes entre serviços.

Consulte com exemplos

Comece pelos exemplos curl e HTTP, depois mapeie os parâmetros no código da sua aplicação.

Opere e monitore

Use códigos de status, custos em créditos e campos de resposta para criar retentativas, logs e alertas.

Kit de desenvolvedor

Saia desta página para docs legíveis por máquina, coleções de requisições, SDKs ou ferramentas para agentes.

Esquema OpenAPI

Gere clientes ou inspecione cada formato de requisição e resposta.

Coleção Postman

Importe requisições prontas para testes manuais e repasse ao time.

SDKs e CLI

Use pacotes mantidos e fluxos de linha de comando em vez de escrever boilerplate.

Integração MCP

Exponha inteligência de domínios para agentes de IA e assistentes internos.

Mapa de parâmetros e resposta

Revise entradas, campos de saída e códigos de status antes de ligar o endpoint ao seu cliente.

Parâmetros da requisição

Parâmetro

domainalert_emailalert_webhook

Campos da resposta

Resposta de Exemplo

brandstotalupdated_at

Cobertura de status

Códigos de Estado HTTP

200201400401402404429

Pontos finais

GET /v1/brand-monitor

Créditos: 1Autenticação: Autenticação necessária

POST /v1/brand-monitor

Créditos: 3Autenticação: Autenticação necessária

domainalert_emailalert_webhook

POST /v1/brand-monitor/scan

Créditos: 6Autenticação: Autenticação necessária

domain

GET /v1/brand-monitor/status

Créditos: 1Autenticação: Autenticação necessária

domain

DELETE /v1/brand-monitor

Créditos: 1Autenticação: Autenticação necessária

domain

POST /v1/brand-monitor/reset-baseline

Créditos: 1Autenticação: Autenticação necessária

domain

PUT /v1/brand-monitor/alerts

Créditos: 1Autenticação: Autenticação necessária

domainalert_emailalert_webhook

Sinais de confiança antes da integração

Documentação transparente, solicitações autenticadas e detalhes visíveis de confiabilidade facilitam avaliar o DomScan antes de publicar.

Status do serviço Artefatos da API

OpenAPI, Swagger, Postman, CLI, SDK e links MCP ficam a um clique.

Chaves API Acesso protegido

Endpoints autenticados usam chaves API com custos de créditos claros antes da chamada.

Cota gratuita Cadastre-se Gratuitamente

Comece com 10.000 créditos mensais e faça upgrade só quando o uso crescer.

Ativo Pedido de Exemplo

Comece pelos exemplos curl e HTTP, depois mapeie os parâmetros no código da sua aplicação.

Principais Recursos

Pontos finais

GET /v1/brand-monitor • POST /v1/brand-monitor • POST /v1/brand-monitor/scan • GET /v1/brand-monitor/status • DELETE /v1/brand-monitor • POST /v1/brand-monitor/reset-baseline • PUT /v1/brand-monitor/alerts

Parâmetro

domain, alert_email, alert_webhook

Códigos de Estado HTTP

200, 201, 400, 401, 402, 404, 429

Créditos / Autenticação

1-6 / Autenticação necessária

Pedido de Exemplo

GET /v1/brand-monitor bash

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

POST /v1/brand-monitor bash

curl -X POST "https://domscan.net/v1/brand-monitor" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{"domain":"acme.com","alert_email":"[email protected]"}'

POST /v1/brand-monitor/scan bash

curl -X POST -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/brand-monitor/scan?domain=acme.com"

Resposta de Exemplo

200 OK json

{
  "brands": [
    {
      "domain": "acme.com",
      "added_at": "2026-04-01T09:00:00Z",
      "last_scan_at": "2026-04-13T11:30:00Z",
      "scan_count": 8,
      "registered_typos": 4,
      "new_threats_since_baseline": 1,
      "has_alerts": true
    }
  ],
  "total": 1,
  "updated_at": "2026-04-13T11:30:00Z"
}

Perguntas frequentes

Quais endpoints estão incluídos?

Este guia cobre 7 endpoints públicos: GET /v1/brand-monitor, POST /v1/brand-monitor, POST /v1/brand-monitor/scan, GET /v1/brand-monitor/status, DELETE /v1/brand-monitor, POST /v1/brand-monitor/reset-baseline, PUT /v1/brand-monitor/alerts.

Esta API exige autenticação?

Sim. Envie sua chave de API com o cabeçalho `X-API-Key` ou `Authorization: Bearer` ao chamar Monitor de marca.

Quantos créditos ela usa?

As solicitações destes guias usam 1-6 créditos, dependendo do endpoint. Para endpoints em lote, os créditos usam a taxa padrão por item.

Onde posso ver os parâmetros completos e os endpoints relacionados?

Use a documentação completa de Monitor de marca para revisar detalhes dos parâmetros, observações de autenticação e endpoints relacionados da mesma família de API.

Ferramentas e Recursos Relacionados

Códigos de Estado HTTP

Documentamos os códigos de estado HTTP que deves tratar para distinguir respostas bem-sucedidas, problemas de autenticação, créditos, limites de taxa, dados em falta e falhas do serviço a montante.

OK 200

Pedido bem-sucedido

Criado 201

Recurso criado com sucesso.

Pedido inválido 400

Parâmetros inválidos

Não autorizado 401

Chave de API ou sessão em falta ou inválida.

Pagamento necessário 402

Não tens créditos suficientes para executar este pedido.

Não encontrado 404

O recurso ou os dados pedidos não foram encontrados.

Demasiados pedidos 429

Limite de taxa excedido

Comece grátis com 10.000 créditos por mês. Use qualquer API pública e adicione créditos somente quando precisar.

Começar Gratuitamente Ver documentação Testar a ferramenta gratuita