Documentazione API

Tutto ciò di cui hai bisogno per l'integrazione di Werk24: installazione, endpoint, richieste e risposte di esempio — sviluppato per l'automazione rapida e affidabile di disegni tecnici.

Visualizza documentazioneProva demo workflow
Anteprima della documentazione API Werk24

Quello che trovi nella documentazione

  • Installazione: Come aggiungere il client Werk24 e ricevere una chiave di prova.
  • Richieste CLI: Invia disegni direttamente dal terminale per test rapidi.
  • Richieste API: Esempi di codice per chiamate API via Python o HTTPS.
  • Riferimento API: Definizioni endpoint, parametri e risposte di esempio.
  • Risoluzione problemi e limitazioni: Codici di stato, risoluzione problemi, formati supportati.
  • FAQ: Risposte a domande frequenti su setup e integrazione.

Avvio rapido

Esempio client Python — estrai metadati, caratteristiche e insights:

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

Cosa restituisce l'API

Tutte le risposte sono JSON. Ask tipici includono Metadata, Features, Insights, Redaction, Balloons.

MetaData
{
"ask_version": "v2",
"ask_type": "META_DATA",
"page_type": "COMPONENT_DRAWING",
"identifiers": [
{
"reference_id": 0,
"language": null,
"value": "WK2401",
"identifier_type": "DRAWING_NUMBER",
"stakeholder": null,
"period": null
}
],
"designation": [
{
"reference_id": 1,
"language": null,
"value": "ADAPTER"
}
],
"languages": [
"ENG"
],
"general_tolerances": null,
"general_roughness": {
"reference_id": 2,
"label": "\u221a",
"confidence": null,
"standard": "ISO 1302:2002",
"machining_allowance": null,
"material_removal_type": "UNSPECIFIED",
"applies_all_around": false,
"direction_of_lay": null,
"manufacturing_process": "",
"conditions": [],
"waviness": null
},
"material_options": [
{
"reference_id": 3,
"material_combination": [
{
"raw_ocr": "20MnCr5",
"standard": "DIN EN 10084",
"designation": "20MnCr5",
"material_category": [
"FERROUS_ALLOY",
"STEEL",
"STRUCTURAL_OR_CONSTRUCTIONAL_STEEL"
]
}
]
}
],
"weight": {
"reference_id": 4,
"value": "1.025",
"unit": "kilogram"
},
"projection_method": {
"reference_id": 5,
"projection_method": "FIRST_ANGLE"
},
"bill_of_material": null,
"unit_systems": [
{
"reference_id": 6,
"unit_system_type": "METRIC"
}
]
}
Features
{
    "ask_version": "v2",
    "ask_type": "FEATURES",
    "page_type": "COMPONENT_DRAWING",
    "dimensions": [
        {
            "reference_id": 0,
            "label": "12 ±0.1",
            "confidence": {
                "score": "0.96"
            },
            "quantity": 1,
            "size": {
                "value": "12",
                "unit": "mm",
                "size_type": "LINEAR",
                "tolerance": {
                    "tolerance_grade": "12",
                    "deviation_lower": "-0.1",
                    "deviation_upper": "0.1",
                    "fit": null,
                    "is_theoretically_exact": false,
                    "is_reference": false,
                    "is_general_tolerance": false,
                    "is_approximation": false
                }
            }
        }
    ]
}
Insights
{
"ask_version": "v2",
"ask_type": "INSIGHTS",
"page_type": "COMPONENT_DRAWING",
"primary_process_options": [
{ "process": "TurningProcess", "requires_secondary_milling": true }
],
"secondary_processes": [
{
"reference_id": 1,
"label": "Anodizing",
"process_category": ["COATING", "COATING_FROM_IONDIZED_STATE", "GALVANIC_COATING", "ANODIZING"],
"confidence": { "score": 0.88 }
}
],
"volume_estimate": { "value": 125.6, "unit": "cm³", "confidence": { "score": 0.94 } }
}

Riferimenti completi: MetaData · Features · Insights · Redaction · Balloons

Perché Werk24?

  • Integrazione senza soluzione di continuità: SDK + HTTPS + webhook che si adattano al tuo stack.
  • Funzioni estese: Meta, features, insights, redaction, balloons — appositamente per disegni tecnici.
  • Developer-friendly: JSON deterministico, punteggi di confidenza e documentazione chiara.
Prova workflowRichiedi chiave di prova API