API क्विकस्टार्ट: अपलोड, जांच, कोटेशन

शुरू करने से पहले

API अतिथि सत्र द्वारा बिना खाते काम करती है। API साइट के अपने पते पर /api के अधीन है। उसे एक बार सेट करें:

API=https://dev.uliketechnology.com/api
F=board.zip

board.zip आपकी Gerber और ड्रिल फ़ाइलों का सपाट zip है। उसमें क्या जाता है, इसके लिए निर्माण और असेंबली के लिए फ़ाइलें देखें। उदाहरणों को curl और jq चाहिए।

अतिथि सत्र के बाद API के प्रत्येक अनुरोध में Authorization: Bearer <token> लगता है। प्रत्येक त्रुटि का समान आकार है:

{ "error": { "code": "VALIDATION_FAILED", "message": "…", "details": {}, "requestId": "…" } }

code पर शाखा करें। message डेवलपर के लिए है।

1. अतिथि सत्र: टोकन एक बार दिखाया जाता है।
2. अपलोड: zip को API द्वारा नामित पते पर, उसके द्वारा नामित हेडर के साथ PUT करें।
3. पूर्ण करें, फिर विश्लेषण होने तक पोल करें।
4. रिपोर्ट: अवलोकन, कौन सी जांचें चलीं और कौन सी नहीं।
5. कोटेशन पूर्वावलोकन।

curl के साथ प्रवाह

क्या ऑर्डर किया जा सकता है पढ़ें। इसके लिए टोकन नहीं चाहिए:

curl -s $API/v1/capabilities | jq '.options[].id'

अतिथि सत्र खोलें। टोकन एक बार दिखाया जाता है और 30 दिन रहता है:

T=$(curl -s -X POST $API/v1/guest-sessions | jq -r .token)

फ़ाइल की घोषणा करें। उत्तर में uploadId, designId, uploadUrl और requiredHeaders हैं:

J=$(curl -s -X POST $API/v1/uploads -H "authorization: Bearer $T" -H 'content-type: application/json' \
  -d "{\"fileName\":\"board.zip\",\"sizeBytes\":$(stat -c %s $F),\"sha256\":\"$(sha256sum $F | cut -d' ' -f1)\",\"purpose\":\"design\"}")

फ़ाइल को उत्तर द्वारा नामित पते पर, requiredHeaders के प्रत्येक हेडर के साथ (सामग्री प्रकार, लंबाई और चेकसम; उनके बिना अपलोड 403 से अस्वीकृत होता है) भेजें। फिर अपलोड पूर्ण करें:

curl -s -X PUT --data-binary @$F \
  $(echo $J | jq -r '.requiredHeaders | to_entries[] | "-H \(.key):\(.value)"') \
  "$(echo $J | jq -r .uploadUrl)"
curl -s -X POST $API/v1/uploads/$(echo $J | jq -r .uploadId)/complete -H "authorization: Bearer $T" | jq .design.status

स्थिति पहले analysing है। डिज़ाइन को बदलने तक पढ़ें। जब वह ready हो, रिपोर्ट उत्तर में है:

D=$(echo $J | jq -r .designId)
curl -s $API/v1/designs/$D -H "authorization: Bearer $T" | jq '.design.status, .report.headline, .report.counts'

शीर्षक no_problems_in_checks_run, problems_found या could_not_check है। checksRun और checksNotRun भी पढ़ें: न चली जांच पास नहीं है। अन्य स्थितियां needs_mapping (परतें PUT /v1/designs/{designId}/layer-mapping से सेट करें), needs_engineer और rejected हैं।

कीमत पूर्वावलोकन मांगें। selection और destinationCountry आवश्यक हैं; खाली selection डिफ़ॉल्ट लेता है:

curl -s -X POST $API/v1/quote-previews -H "authorization: Bearer $T" -H 'content-type: application/json' \
  -d "{\"designId\":\"$D\",\"quantities\":{\"boardsFabricated\":10,\"boardsAssembled\":0},\"selection\":{},\"destinationCountry\":\"DE\"}" \
  | jq '.mode, .reviewReasons, .totalMinor'

mode instant (कीमत जैसी दिखाई गई वैसी है) या review (इंजीनियर उसकी पुष्टि करता है) है; reviewReasons बताता है क्यों। totalMinor उत्तर की currency की छोटी इकाइयों में है, और जब इंजीनियर को कार्य की कीमत तय करनी हो तो अनुपस्थित है। कोटेशन रखने के लिए POST /v1/quotes समान बॉडी लेता है।

JavaScript क्लाइंट के साथ वही प्रवाह

@ulike/sdk क्लाइंट इन रूट को लपेटता है। वह अभी पैकेज के रूप में प्रकाशित नहीं है; यह उसका आकार है, ताकि आप fetch के साथ समान कॉल लिख सकें। विधि नाम:

import { createClient } from '@ulike/sdk';

let token;
const api = createClient({ baseUrl: 'https://dev.uliketechnology.com/api', token: () => token });

const caps = await api.capabilities();
token = (await api.createGuestSession()).token;
const started = await api.uploadDesign({ name: 'board.zip', bytes }); // announce, PUT, complete
const view = await api.waitForDesign(started.design.id); // polls getDesign
const preview = await api.previewQuote({
  designId: view.design.id,
  quantities: { boardsFabricated: 10, boardsAssembled: 0 },
  selection: {},
  destinationCountry: 'DE',
});

अन्य विधियां createUpload, completeUpload, getDesign, setLayerMapping, validateDesign, getValidation, waitForValidation, createQuote, getQuote और reviseQuote हैं। त्रुटियां status और code के साथ ApiClientError के रूप में फेंकी जाती हैं।

ऑर्डर की जांच

अपलोड के बाद आपको मिलने वाली रिपोर्ट केवल फ़ाइलों पर बनी है। फ़ाइलों को ऑर्डर के विरुद्ध जांचने के लिए, quantities और selection रखने वाले order के साथ POST /v1/designs/{designId}/validations (validateDesign) कॉल करें। उत्तर स्थिति है: running, failed या done। running के दौरान, done होने तक प्रत्येक सेकंड या दो में GET /v1/validations/{reportId} (getValidation) पढ़ें।

1. zip अपलोड करें।
2. रिपोर्ट पढ़ें।
3. ठीक करें और नए डिज़ाइन के रूप में अपलोड करें। जब सुधार कार्य, कीमत या वितरण समय बदले तो रुकें और व्यक्ति से पूछें।
4. साफ़ फ़ाइलें: ऑर्डर की जांच चलाएं।

ऐसे विकल्पों वाला कोटेशन या पूर्वावलोकन जो अन्य सीमाएं लाते हैं (मोटा कॉपर, अन्य मोटाई) उसे उस चयन के लिए जांच चाहिए। यदि कोई नहीं है, एक शुरू होता है, और पूर्वावलोकन समीक्षा कारण file_check_pending और उसके reportId के साथ check रखता है। कीमत तुरंत दिखाई जाती है, पर कोटेशन जांच होने तक review में रहता है। ऊपर के अनुसार जांच पढ़ें, फिर पूर्वावलोकन फिर मांगें।

आपको मिलने वाली त्रुटियां

DESIGN_REJECTED (अपलोड अस्वीकृत हुआ; details.reason देखें), गायब या गलत टोकन के लिए UNAUTHENTICATED (गलत टोकन सार्वजनिक रूट पर भी अस्वीकृत होता है), और अभी खुले नहीं रूट के लिए FEATURE_DISABLED भी संभव हैं।

बिना खाते दैनिक भत्ता

अतिथि सत्र के पास कंप्यूट का दैनिक भत्ता है। अपलोड और शुरू जांचें सरल पठन से अधिक महंगी हैं, और एक नेटवर्क पते से कई अतिथि सत्र खोलना भी गिना जाता है। नए चयन के लिए साइट द्वारा स्वयं शुरू जांच समान भत्ते पर चार्ज होती है। जब वह खर्च हो जाता है, आपको उसके रीसेट होने की तिथि के साथ ANONYMOUS_BUDGET_SPENT मिलता है। साइन-इन कॉलर इस तरह नहीं गिने जाते।

API आज क्या नहीं कर सकती: ऑर्डर, भुगतान, API कुंजियां और एजेंटों के लिए साइन-इन योजनाबद्ध हैं और उपलब्ध नहीं हैं। योजनाबद्ध MCP सर्वर MCP क्या है और एजेंट कैसे ऑर्डर करते हैं में वर्णित है।