Documentation API

Tout ce dont vous avez besoin pour l'intégration de Werk24 : installation, points de terminaison, requêtes et exemples de réponses - développés pour une automatisation rapide et fiable des dessins techniques.

Aperçu de la documentation Werk24-API

Vous pouvez trouver cela dans la documentation

  • Installation: Comment ajouter le client Werk24 et recevoir une clé de test.
  • Demandes de Cli: Envoyer des dessins directement depuis le terminal pour des tests rapides.
  • Demandes API: Exemples de code pour les appels API via Python ou HTTPS.
  • Référence API: Définitions des points de terminaison, paramètres et exemples de réponses.
  • Dépannage et restrictions: Codes d'état, dépannage, formats pris en charge.
  • FAQ: Réponses aux questions les plus fréquentes concernant l'installation et l'intégration.

Démarrage rapide

Exemple de client Python - extraction de métadonnées, de caractéristiques et d'informations :

from werk24 import read_drawing_sync, get_test_drawing, AskMetaData\nprint(read_drawing_sync(get_test_drawing(), [AskMetaData()]))

Ce que l'API renvoie

Toutes les réponses sont au format JSON. Les demandes typiques comprennent Métadonnées, caractéristiques, aperçus, Rédaction, ballons.

Métadonnées
{\n"ask_version": "v2",\n"ask_type": "META_DATA",\n"page_type": "COMPONENT_DRAWING",\n"identifiers": [\n{\n"reference_id": 0,\n"language": null,\n"value": "WK2401",\n"identifier_type": "DRAWING_NUMBER",\n"stakeholder": null,\n"period": null\n}\n],\n"designation": [\n{\n"reference_id": 1,\n"language": null,\n"value": "ADAPTER"\n}\n],\n"languages": [\n"ENG"\n],\n"general_tolerances": null,\n"general_roughness": {\n"reference_id": 2,\n"label": "\\u221a",\n"confidence": null,\n"standard": "ISO 1302:2002",\n"machining_allowance": null,\n"material_removal_type": "UNSPECIFIED",\n"applies_all_around": false,\n"direction_of_lay": null,\n"manufacturing_process": "",\n"conditions": [],\n"waviness": null\n},\n"material_options": [\n{\n"reference_id": 3,\n"material_combination": [\n{\n"raw_ocr": "20MnCr5",\n"standard": "DIN EN 10084",\n"designation": "20MnCr5",\n"material_category": [\n"FERROUS_ALLOY",\n"STEEL",\n"STRUCTURAL_OR_CONSTRUCTIONAL_STEEL"\n]\n}\n]\n}\n],\n"weight": {\n"reference_id": 4,\n"value": "1.025",\n"unit": "kilogram"\n},\n"projection_method": {\n"reference_id": 5,\n"projection_method": "FIRST_ANGLE"\n},\n"bill_of_material": null,\n"unit_systems": [\n{\n"reference_id": 6,\n"unit_system_type": "METRIC"\n}\n]\n}
Caractéristiques
{\n    "ask_version": "v2",\n    "ask_type": "FEATURES",\n    "page_type": "COMPONENT_DRAWING",\n    "dimensions": [\n        {\n            "reference_id": 0,\n            "label": "12 ±0.1",\n            "confidence": {\n                "score": "0.96"\n            },\n            "quantity": 1,\n            "size": {\n                "value": "12",\n                "unit": "mm",\n                "size_type": "LINEAR",\n                "tolerance": {\n                    "tolerance_grade": "12",\n                    "deviation_lower": "-0.1",\n                    "deviation_upper": "0.1",\n                    "fit": null,\n                    "is_theoretically_exact": false,\n                    "is_reference": false,\n                    "is_general_tolerance": false,\n                    "is_approximation": false\n                }\n            }\n        }\n    ],\n    "threads": [\n        {\n            "reference_id": 1,\n            "label": "M5×0.8—6g/6H",\n            "thread_type": "ISO_METRIC",\n            "quantity": 1,\n            "diameter": "5",\n            "spacing": {\n                "pitch_in_mm": "0.8",\n                "threads_per_inch": "31.75"\n            },\n            "handedness": "RIGHT",\n            "depth": null,\n            "confidence": {\n                "score": 0.95\n            }\n        }\n    ],\n    "bores": [\n        {\n            "reference_id": 2,\n            "label": "Ø6 H7 (+0.012/0) ↧13.4",\n            "quantity": 1,\n            "counterbore": null,\n            "countersink": null,\n            "counterdrill": null,\n            "diameter": {\n                "size_type": "DIAMETER",\n                "value": "6",\n                "tolerance": {\n                    "deviation_lower": "0",\n                    "deviation_upper": "0.012",\n                    "tolerance_grade": "7",\n                    "fit": "H7",\n                    "is_theoretically_exact": false,\n                    "is_reference": false,\n                    "is_general_tolerance": false,\n                    "is_approximation": false\n                },\n                "unit": "mm"\n            },\n            "depth": {\n                "depth_type": "SIZE",\n                "value": "13.4",\n                "tolerance": null,\n                "unit": "mm"\n            },\n            "thread": null,\n            "confidence": {\n                "score": 0.94\n            }\n        }\n    ],\n    "chamfers": [\n        {\n            "reference_id": 3,\n            "label": "1 x 45°",\n            "quantity": 1,\n            "size": {\n                "size_type": "LINEAR",\n                "value": "1",\n                "tolerance": {\n                    "deviation_lower": null,\n                    "deviation_upper": null,\n                    "tolerance_grade": null,\n                    "fit": null,\n                    "is_theoretically_exact": false,\n                    "is_reference": false,\n                    "is_general_tolerance": true,\n                    "is_approximation": false\n                },\n                "unit": "mm"\n            },\n            "angle": {\n                "size_type": "ANGULAR",\n                "value": "45",\n                "tolerance": {\n                    "deviation_lower": null,\n                    "deviation_upper": null,\n                    "tolerance_grade": null,\n                    "fit": null,\n                    "is_theoretically_exact": false,\n                    "is_reference": false,\n                    "is_general_tolerance": true,\n                    "is_approximation": false\n                },\n                "unit": "degree"\n            }\n        }\n    ],\n    "roughnesses": [\n        {\n            "reference_id": 4,\n            "label": "○√",\n            "confidence": {\n                "score": "1.00"\n            },\n            "standard": "ISO 1302:2002",\n            "machining_allowance": null,\n            "material_removal_type": "PROHIBITED",\n            "applies_all_around": false,\n            "direction_of_lay": null,\n            "manufacturing_process": "",\n            "conditions": [],\n            "waviness": null\n        }\n    ],\n    "gdnts": [\n        {\n            "reference_id": 26,\n            "label": "[⟂|0.5|A]",\n            "confidence": {\n                "score": "0.98"\n            },\n            "characteristic": "⟂",\n            "zone": {\n                "value": {\n                    "value": "0.5",\n                    "unit": "mm",\n                    "size_type": "LINEAR",\n                    "tolerance": null\n                },\n                "extend": null,\n                "combination": null,\n                "offset": null,\n                "constraint": null\n            },\n            "feature": null,\n            "reference": null,\n            "material_condition": null,\n            "state": null,\n            "datums": [{ "label": "A" }]\n        }\n    ],\n    "radii": [\n        {\n            "reference_id": 35,\n            "label": "R7 0/-0.5",\n            "confidence": {\n                "score": "0.96"\n            },\n            "quantity": 1,\n            "curvature_type": null,\n            "size": {\n                "value": "7",\n                "unit": "mm",\n                "size_type": "LINEAR",\n                "tolerance": {\n                    "tolerance_grade": "14",\n                    "deviation_lower": "-0.5",\n                    "deviation_upper": "0",\n                    "fit": null,\n                    "is_theoretically_exact": false,\n                    "is_reference": false,\n                    "is_general_tolerance": false,\n                    "is_approximation": false\n                }\n            }\n        }\n    ]\n}
Aperçus
{\n"ask_version": "v2",\n"ask_type": "INSIGHTS",\n"page_type": "COMPONENT_DRAWING",\n"primary_process_options": [\n{ "process": "TurningProcess", "requires_secondary_milling": true }\n],\n"secondary_processes": [\n{\n"reference_id": 1,\n"label": "Anodizing",\n"process_category": ["COATING", "COATING_FROM_IONDIZED_STATE", "GALVANIC_COATING", "ANODIZING"],\n"confidence": { "score": 0.88 }\n}\n],\n"volume_estimate": { "value": 125.6, "unit": "cm³", "confidence": { "score": 0.94 } }\n}

Références complètes : Métadonnées · Caractéristiques · Aperçus · Rédaction · Ballons

Pourquoi Werk24 ?

  • Intégration transparente: SDK + HTTPS + webhooks qui s'adaptent à votre stack.
  • Fonctions étendues: Méta, caractéristiques, aperçus, rédaction, bulles - en particulier pour les dessins techniques.
  • Convivialité pour les développeurs: JSON déterministe, scores de confiance et documentation claire.