read_domain_proof

Lee la prueba del dominio

POST https://emporium.ultravioletadao.xyz/api/businesses/{slug}/verification/checks

Por dónde se llega

API RESTVivoPOST https://emporium.ultravioletadao.xyz/api/businesses/{slug}/verification/checks
MCPMuy pronto
CLIMuy pronto
SDK de PythonMuy pronto
SDK de TypeScriptMuy pronto
SDK de RustMuy pronto

Vivo: se usa hoy, para leer y para escribir. Solo lectura: hoy se lee y no se escribe. Muy pronto: todavía no está.

Parámetros

NombreDóndeRequeridoEsquemaQué es
slugcaminosístring
X-Emporium-ClavecabecerasístringLa clave de borrador del negocio: se muestra una vez, en la respuesta de POST /api/businesses

El cuerpo de la petición

Requerido.

application/json

{
  "$ref": "#/components/schemas/CuerpoLectura"
}

Respuestas

200

Correcto

application/json

{
  "$ref": "#/components/schemas/LecturaHecha"
}

Cualquier otro status

Un error: en JSON, el sobre único, cuyo error.codigo es uno de una lista cerrada

application/json

{
  "$ref": "#/components/schemas/SobreDeError"
}

Esquemas

Los que nombra esta operación, tal cual están en components.schemas del contrato.

CodigoDeError
{
  "enum": [
    "dominio_invalido",
    "slug_ocupado",
    "tenant_no_encontrado",
    "tenant_no_publicado",
    "tenant_suspendido",
    "clave_invalida",
    "estado_no_permite",
    "ventana_no_cumplida",
    "metodo_invalido",
    "manifiesto_invalido",
    "categoria_prohibida",
    "terminos_no_aceptados",
    "canal_no_confirmado",
    "version_de_terminos_desconocida",
    "pedido_invalido",
    "faltan_datos",
    "respuesta_invalida",
    "firma_invalida",
    "enlace_vencido",
    "enlace_ya_usado",
    "demasiadas_peticiones",
    "parametro_invalido",
    "metodo_no_permitido",
    "firma_no_configurada",
    "correo_no_configurado",
    "terminos_no_configurados",
    "casa_no_configurada",
    "almacen_no_disponible",
    "error_interno",
    "paybox_no_configurado",
    "boveda_no_disponible",
    "sesion_requerida",
    "estado_oauth_invalido",
    "consentimiento_rechazado",
    "concesion_insegura",
    "paybox_no_responde",
    "paybox_rechazo",
    "sin_vinculo",
    "vinculo_revocado",
    "vinculo_vencido",
    "reconexion_requerida",
    "vinculo_ajeno",
    "renovacion_en_curso"
  ],
  "type": "string"
}
CuerpoDelError
{
  "additionalProperties": false,
  "properties": {
    "codigo": {
      "$ref": "#/components/schemas/CodigoDeError"
    },
    "detalles": {
      "items": {
        "$ref": "#/components/schemas/Detalle"
      },
      "type": "array"
    },
    "mensaje": {
      "type": "string"
    },
    "peticion_id": {
      "type": "string"
    }
  },
  "required": [
    "codigo",
    "detalles",
    "mensaje",
    "peticion_id"
  ],
  "type": "object"
}
CuerpoLectura
{
  "additionalProperties": false,
  "properties": {
    "metodo": {
      "$ref": "#/components/schemas/MetodoVerificacion"
    }
  },
  "required": [
    "metodo"
  ],
  "type": "object"
}
Detalle
{
  "additionalProperties": false,
  "properties": {
    "campo": {
      "type": "string"
    },
    "problema": {
      "type": "string"
    }
  },
  "required": [
    "campo",
    "problema"
  ],
  "type": "object"
}
EstadoTenant
{
  "enum": [
    "borrador",
    "manifiesto_valido",
    "verificacion_pendiente",
    "verificado",
    "publicado",
    "despublicado",
    "suspendido",
    "rechazado_por_categoria",
    "verificacion_fallida"
  ],
  "type": "string"
}
LecturaHecha
{
  "properties": {
    "detalle": {
      "type": [
        "string",
        "null"
      ]
    },
    "estado_tenant": {
      "$ref": "#/components/schemas/EstadoTenant"
    },
    "lectura": {
      "format": "uint32",
      "minimum": 0,
      "type": "integer"
    },
    "lecturas": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "leido_en": {
      "type": "string"
    },
    "metodo": {
      "$ref": "#/components/schemas/MetodoVerificacion"
    },
    "proxima_habilitada_desde": {
      "type": [
        "string",
        "null"
      ]
    },
    "resultado": {
      "$ref": "#/components/schemas/ResultadoDeLaLectura"
    }
  },
  "required": [
    "detalle",
    "estado_tenant",
    "lectura",
    "lecturas",
    "leido_en",
    "metodo",
    "proxima_habilitada_desde",
    "resultado"
  ],
  "type": "object"
}
MetodoVerificacion
{
  "enum": [
    "dns",
    "archivo"
  ],
  "type": "string"
}
ResultadoDeLaLectura
{
  "enum": [
    "ok",
    "token_no_encontrado",
    "token_distinto",
    "dominio_no_resuelve",
    "destino_no_permitido",
    "tiempo_agotado",
    "respuesta_no_valida"
  ],
  "type": "string"
}
SobreDeError
{
  "additionalProperties": false,
  "properties": {
    "error": {
      "$ref": "#/components/schemas/CuerpoDelError"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}