Documentación API

Todo lo que necesita para la integración de Werk24: Instalación, puntos finales, ejemplos de consulta y respuestas de muestra: desarrollado para la automatización rápida y fiable de dibujos técnicos.

Vista previa de la documentación de la API de Werk24

Qué encontrará en los documentos

  • Instalación: Cómo añadir el cliente Werk24 y recibir una clave de prueba.
  • Peticiones CLI: Envía dibujos directamente desde el terminal para realizar pruebas rápidas.
  • Solicitudes API: Ejemplos de código para llamadas a la API a través de Python o HTTPS.
  • Referencia API: Definiciones, parámetros y ejemplos de respuestas.
  • Tratamiento de errores y restricciones: Códigos de estado, solución de problemas, formatos compatibles.
  • Preguntas frecuentes: Respuestas a preguntas habituales sobre configuración e integración.

Inicio rápido

Ejemplo de cliente Python - Extraiga metadatos, características y perspectivas:

from werk24 import read_drawing_sync, get_test_drawing, AskMetaData
print(read_drawing_sync(get_test_drawing(), [AskMetaData()]))

Qué devuelve la API

Todas las respuestas son JSON. Las preguntas típicas incluyen MetaData, Features, Insights, Redaction y Balloons.

MetaDatos
{
    "preguntar_versión": "v2",
    "tipo_pregunta": "META_DATA",
    "tipo_página": "COMPONENTE_DIBUJO",
    "identificadores": [
        {
            "reference_id": 0,
            "idioma": null,
            "valor": "WK2401",
            "tipo_identificador": "NÚMERO DE DIBUJO",
            "partes interesadas": null,
            "periodo": null
        }
    ],
    "designación": [
        {
            "reference_id": 1,
            "idioma": null,
            "valor": "ADAPTADOR"
        }
    ],
    "idiomas": [
        "ENG"
    ],
    "tolerancias_generales": null,
    "rugosidad_general": {
        "reference_id": 2,
        "etiqueta": "√",
        "confianza": null,
        "estándar": "ISO 1302:2002",
        "indemnización_mecanizado": null,
        "tipo_remoción_material": "UNSPECIFIED",
        "se_aplica_a_todos": false,
        "dirección_de_colocación": null,
        "proceso_de_fabricación": "",
        "condiciones": [],
        "ondulación": null
    },
    "opciones_materiales": [
        {
            "reference_id": 3,
            "combinación_material": [
                {
                    "crud_ocr": "20MnCr5",
                    "estándar": "DIN EN 10084",
                    "designación": "20MnCr5",
                    "categoría_material": [
                        "ALLOY_FERROSO",
                        "ACERO",
                        "ACERO_ESTRUCTURAL_O_DE_CONSTRUCCIÓN"
                    ]
                }
            ]
        }
    ],
    "peso": {
        "reference_id": 4,
        "valor": "1.025",
        "unidad": "kilogramo"
    },
    "método_de_proyección": {
        "reference_id": 5,
        "método_de_proyección": "PRIMER_ÁNGULO"
    },
    "lista_de_material": null,
    "sistemas_unitarios": [
        {
            "reference_id": 6,
            "tipo_sistema_unidad": "MÉTRICO"
        }
    ]
}
Características
{
    "preguntar_versión": "v2",
    "tipo_pregunta": "CARACTERÍSTICAS",
    "tipo_página": "COMPONENTE_DIBUJO",
    "dimensiones": [
        {
            "reference_id": 0,
            "etiqueta": "12 ±0.1",
            "confianza": {
                "puntuación": "0.96"
            },
            "cantidad": 1,
            "talla": {
                "valor": "12",
                "unidad": "mm",
                "tipo_tamaño": "LINEAL",
                "tolerancia": {
                    "grado_tolerancia": "12",
                    "desviación_inferior": "-0.1",
                    "desviación_superior": "0.1",
                    "ajuste": null,
                    "es_teóricamente_exacto": false,
                    "is_reference": false,
                    "is_general_tolerance": false,
                    "es_aproximación": false
                }
            }
        }
    ],
    "hilos": [
        {
            "reference_id": 1,
            "etiqueta": "M5×0,8-6g/6H",
            "tipo_hilo": "ISO_METRIC",
            "cantidad": 1,
            "diámetro": "5",
            "espaciado": {
                "paso_en_mm": "0.8",
                "hilos_por_pulgada": "31.75"
            },
            "handedness": "DERECHA",
            "profundidad": null,
            "confianza": {
                "puntuación": 0.95
            }
        }
    ],
    "taladros": [
        {
            "reference_id": 2,
            "etiqueta": "Ø6 H7 (+0,012/0) ↧13,4",
            "cantidad": 1,
            "avellanador": null,
            "avellanador": null,
            "avellanador": null,
            "diámetro": {
                "tipo_tamaño": "DIÁMETRO",
                "valor": "6",
                "tolerancia": {
                    "desviación_inferior": "0",
                    "desviación_superior": "0.012",
                    "grado_tolerancia": "7",
                    "ajuste": "H7",
                    "es_teóricamente_exacto": false,
                    "is_reference": false,
                    "is_general_tolerance": false,
                    "es_aproximación": false
                },
                "unidad": "mm"
            },
            "profundidad": {
                "tipo_profundidad": "TALLA",
                "valor": "13.4",
                "tolerancia": null,
                "unidad": "mm"
            },
            "hilo": null,
            "confianza": {
                "puntuación": 0.94
            }
        }
    ],
    "chaflanes": [
        {
            "reference_id": 3,
            "etiqueta": "1 x 45°",
            "cantidad": 1,
            "talla": {
                "tipo_tamaño": "LINEAL",
                "valor": "1",
                "tolerancia": {
                    "desviación_inferior": null,
                    "desviación_superior": null,
                    "grado_tolerancia": null,
                    "ajuste": null,
                    "es_teóricamente_exacto": false,
                    "is_reference": false,
                    "is_general_tolerance": true,
                    "es_aproximación": false
                },
                "unidad": "mm"
            },
            "ángulo": {
                "tipo_tamaño": "ANGULAR',
                "valor": "45",
                "tolerancia": {
                    "desviación_inferior": null,
                    "desviación_superior": null,
                    "grado_tolerancia": null,
                    "ajuste": null,
                    "es_teóricamente_exacto": false,
                    "is_reference": false,
                    "is_general_tolerance": true,
                    "es_aproximación": false
                },
                "unidad": "grado"
            }
        }
    ],
    "rugosidades": [
        {
            "reference_id": 4,
            "etiqueta": "○√",
            "confianza": {
                "puntuación": "1.00"
            },
            "estándar": "ISO 1302:2002",
            "indemnización_mecanizado": null,
            "tipo_remoción_material": "PROHIBIDO",
            "se_aplica_a_todos": false,
            "dirección_de_colocación": null,
            "proceso_de_fabricación": "",
            "condiciones": [],
            "ondulación": null
        }
    ],
    "gdnts": [
        {
            "reference_id": 26,
            "etiqueta": "[⟂|0.5|A]",
            "confianza": {
                "puntuación": "0.98"
            },
            "característica": "⟂",
            "zona": {
                "valor": {
                    "valor": "0.5",
                    "unidad": "mm",
                    "tipo_tamaño": "LINEAL",
                    "tolerancia": null
                },
                "ampliar": null,
                "combinación": null,
                "offset": null,
                "restricción": null
            },
            "función": null,
            "referencia": null,
            "condición_material": null,
            "estado": null,
            "fechas": [{ "etiqueta": "A" }]
        }
    ],
    "radios": [
        {
            "reference_id": 35,
            "etiqueta": "R7 0/-0.5",
            "confianza": {
                "puntuación": "0.96"
            },
            "cantidad": 1,
            "tipo_curvatura": null,
            "talla": {
                "valor": "7",
                "unidad": "mm",
                "tipo_tamaño": "LINEAL",
                "tolerancia": {
                    "grado_tolerancia": "14",
                    "desviación_inferior": "-0.5",
                    "desviación_superior": "0",
                    "ajuste": null,
                    "es_teóricamente_exacto": false,
                    "is_reference": false,
                    "is_general_tolerance": false,
                    "es_aproximación": false
                }
            }
        }
    ]
}
Perspectivas
{
    "preguntar_versión": "v2",
    "tipo_pregunta": "INSIGHTS",
    "tipo_página": "COMPONENTE_DIBUJO",
    "opciones_proceso_primario": [
        { "proceso": "TorneadoProceso", "requiere_fresado_secundario": true }
    ],
    "procesos_secundarios": [
        {
            "reference_id": 1,
            "etiqueta": "Anodizado",
            "categoría_proceso": ["REVESTIMIENTO", "RECUBRIMIENTO_DE_ESTADO_IONDIZADO", "RECUBRIMIENTO_GALVÁNICO", "ANODIZAR"],
            "confianza": { "puntuación": 0.88 }
        }
    ],
    "estimación_volumen": { "valor": 125.6, "unidad": "cm³", "confianza": { "puntuación": 0.94 } }
}

Referencias completas: MetaDatos · Características · Perspectivas · Redacción · Globos

¿Por qué Werk24?

  • Integración perfecta: SDK + HTTPS + webhooks que coincidan con su pila.
  • Funciones avanzadas: Meta, Features, Insights, Redaction, Balloons - especialmente para dibujos técnicos.
  • Para desarrolladores: JSON determinista, puntuaciones de confianza y documentación clara.