01
Importēt kolekciju
Programmā „Postman“: File → Import → Link. Ielīmējiet JSON URL, kas norādīts augšējā lejupielādes pogā. Postman pievieno kolekciju — kopā ar tās mainīgajiem — jūsu darba videi.
Izstrādātāji · Postman kolekcija
Importējiet kolekciju. Piecu minūšu laikā sasniedziet API.
Iepriekš sagatavota „Postman“ kolekcija ar praktiskiem piemēriem Fabrixa integrācijai ar API. Ievadiet savas piekļuves datus, izietiet cauri pieprasījumiem un apskatiet reālas atbildes no API, pirms uzrakstāt pat vienu rindu integrācijas koda. Kolekcija tiek atjaunināta atbilstoši API versijām — tā tiek atjaunināta vienlaikus ar API.
Kas ir iekļauts kolekcijā
Katrs galapunkts ar datu piemēriem.
Sakārtoti mapēs pēc resursiem. Katram pieprasījumam ir pievienots izstrādāts piemērs, divi iepriekš iestatīti autentifikācijas galvenes un saglabāta atbildes paraugs — tādējādi jūs varat iepriekš apskatīt atbildes struktūru, pirms nosūtāt pieprasījumu.
Autori un produkti
- SAŅEMT /ping — pārbaudīt piekļuves datus
- SAŅEMT /products — saraksts un lappušu numerācija (SKU + variant_id)
- Pilnās lauku shēmas Swagger atsauces dokumentācijā
Pasūtījumi
- POST /orders — izveidot pasūtījumu
- SAŅEMT /orders/{id}/fulfillments — ražošanas procesa izsekošana
Studija un tīmekļa paziņojumi
- SAŅEMT /v2/studio/pielāgojumi/{atslēga}/priekšskatījums
- Webhook datu saturs + HMAC pārbaude (piemērs)
Importēšana 30 sekundēs
Fails → Importēt → Saite → Ielīmēt URL.
02
Atveriet cilni „Mainīgie”
Kolekcijai ir savi mainīgie — base_url ir iepriekš aizpildīts; access_token un application_key ir vietas aizstājēji. Nav nepieciešams atsevišķs vides fails.
03
Ielīmējiet savas atslēgas
Ievadiet savā vadības panelī pārdošanas kanāla lietojumprogrammas piekļuves žetonu un lietojumprogrammas atslēgu, nospiediet „Saglabāt“, un katrs pieprasījums tiks autentificēts.
Vides mainīgie
Kas ir iekļauts env failā?.
Viena bāzes URL adrese, divas piekļuves dati, kas jau iekļauti kolekcijā. Izstrādājiet sistēmu, balstoties uz vienu pārdošanas kanālu, un pēc tam, kad sāksiet darbību, ievietojiet savas reālās kanāla atslēgas — tā pati kolekcija, tie paši pieprasījumi.
Kolekcijas mainīgie
{
"base_url": "https://api.fabrixa.com/v2/integration",
"studio_base": "https://api.fabrixa.com/v2/studio",
"access_token": "APPLICATION_ACCESS_TOKEN",
"application_key": "APPLICATION_KEY"
}
Autentifikācija jau ir konfigurēta
Abi autentifikācijas galvenes, kas ir iepriekš iestatītas katrā pieprasījumā.
Katram pieprasījumam ir Authorization: Bearer {{access_token}} un X-Application-Key: {{application_key}}, kas tiek ņemti no kolekcijas mainīgajiem — nav nepieciešama galvenes konfigurēšana katram pieprasījumam. Pāreja no viena pārdošanas kanāla uz citu notiek, vienkārši rediģējot šos divus mainīgos: tā pati kolekcija, atšķirīgas atslēgas.
Praktiskie piemēri
Katram pieprasījumam ir pievienots parauga saturs un saglabāta atbilde.
Šī kolekcija nav tikai URL saīsinājumi — katram pieprasījumam ir izstrādāts piemēra saturs, tāpēc jūs varat nospiest pogu „Sūtīt” un apskatīt reālus datus. Saglabātās atbilžu piemēri atrodas paneļā „Piemēri”, lai tos varētu izmantot bezsaistē.
Pārbaudīt autentifikāciju
Vispirms pārbauda, vai jūsu lietojumprogrammas piekļuves žetons un lietojumprogrammas atslēga ir derīgi. Veiksmīgas darbības gadījumā tiek atgriezts kods 200, bet, ja trūkst kāda galvenes, — 401.
Saraksts ar produktiem
Pieprasījums pēc kataloga ar lappušu numerāciju. Produktus atgriež pa lappusēm saites / meta / datu aploksnē, norādot katram produktam SKU un varianta identifikatoru.
Izveidot pasūtījumu
Paraugs vienas vienības T-krekla pasūtījumam ar avota PDF failu, klienta un piegādes adresi. Noklikšķiniet uz „Sūtīt”, lai apskatītu izveidoto pasūtījumu ar tā identifikācijas numuru Fabrixa.
Ražošanas uzskaite
Parādīta katra izstrādājuma ražošanas posmi (drukāšana, fiksēšana, mazgāšana, šūšana) ar statusiem „gaida apstiprinājumu”, „procesā”, „pabeigts” un „noraidīts” attiecībā uz veikto pasūtījumu.
Studijas priekšskatījums
Atgriež renderētu priekšskatījuma attēlu saglabātai „Studio“ pielāgošanai — to var tieši ievietot groza sīktēlu sarakstā.
Paraksta pārbaude
Praktisks piemērs, kā pirms apstrādes pārrēķināt HMAC-SHA256 parakstu un salīdzināt to ar x-webhook-signature.
Versiju pārvaldība
Kolekcija tiek atjaunināta vienlaikus ar API.
Katrā API izlaidumā atjaunināta kolekcija tiek publicēta tajā pašā URL adresē. Veiciet atkārtotu importēšanu, lai iegūtu jaunus galapunktus un paraugu datu slodzes — esošie pieprasījumi jūsu saglabātajā versijā turpinās darboties, līdz šis galapunkts faktiski vairs netiks atbalstīts.
Stabila URL adrese
Kolekcijas JSON URL ir nemainīgs. Atkārtota importēšana lejupielādē jaunāko versiju — URL starp izlaidumiem nemainās.
Atsauce uz izmaiņu žurnālu
Skatīt izmaiņu žurnāls lai iepazītos ar atbilstošajām API versijas piezīmēm — kas ir mainīts, kas pievienots un kas vairs netiek atbalstīts.
Novecojušo funkciju politika
Endpunktiem tiek piešķirts 12 mēnešu pārejas periods. Kolekcija aprakstā atzīmē novecojušos pieprasījumus, tāpēc tos ir grūti nepamanīt, pirms rodas kādas problēmas.
Bieži uzdotie jautājumi
Kolekcija „Pasts”, atbildes
Kā importēt „Fabrixa Postman“ kolekciju?
Programmā „Postman“ izvēlieties „File“ (Fails), pēc tam „Import“ (Importēt), tad „Link“ (Saite) un ielīmējiet kolekcijas JSON URL. „Postman“ pievienos kolekciju kopā ar tās mainīgajiem jūsu darba vidē — „base_url“ jau ir iepriekš aizpildīts, savukārt „access_token“ un „application_key“ ir vietas turētāji, kurus jums jāaizstāj ar savu lietojumprogrammas piekļuves žetonu un lietojumprogrammas atslēgu.
Kādi galapunkti ir iekļauti „Fabrixa Postman“ kolekcijā?
Kolekcija ietver GET /ping, lai pārbaudītu autentifikācijas datus, GET /products, lai parādītu katalogu un sadalītu to pa lapām, POST /orders, lai izveidotu pasūtījumu, GET /orders/{id}/fulfillments, lai sekotu līdzi ražošanas procesam, „Studio“ priekšskatīšanas galapunktu, kā arī praktisku piemēru par webhook paraksta pārbaudi. Tā ir izstrādāta v2 Integration API un prasa Postman v10 vai jaunāku versiju.
Kā tiek konfigurēta autentifikācija Fabrixa Postman kolekcijā?
Katram pieprasījumam kolekcijā jau ir pievienoti divi nepieciešamie galvenes — „Authorization: Bearer {{access_token}}“ un „X-Application-Key: {{application_key}}“ — kas tiek ņemti no kolekcijas mainīgajiem. Ielīmējot savu lietojumprogrammas piekļuves žetonu un lietojumprogrammas atslēgu šajos mainīgajos, katrs pieprasījums tiek autentificēts uzreiz, bez atsevišķas konfigurācijas katram pieprasījumam.
Vai „Fabrixa Postman“ kolekcija tiek atjaunināta, ja mainās „API“?
Jā — katrā API izlaidumā tiek publicēta atjaunināta kolekcija ar to pašu pastāvīgo URL, tāpēc, veicot atkārtotu importēšanu, tiek lejupielādēti jaunākie galapunkti un parauga datu slodzes. Galapunktiem tiek piešķirts 12 mēnešu pārejas periods, un kolekcijā novecojušie pieprasījumi tiek atzīmēti to aprakstā, pirms rodas kādas darbības traucējumi.
Ko atgriež pieprasījums GET /orders/{id}/fulfillments?
Tā izgūst katra izstrādājuma ražošanas statusu attiecībā uz veikto pasūtījumu, aptverot tādus posmus kā drukāšana, fiksēšana, mazgāšana un šūšana, kur katrs no tiem tiek atspoguļots kā „gaida apstiprinājumu”, „procesā”, „pabeigts” vai „noraidīts”. „Postman” kolekcijā ir iekļauts praktisks piemērs, lai atbildes formātu varētu pārbaudīt, pirms to integrē sistēmā.
Lejupielādēt un sākt
Iegūstiet kolekciju. Nosūtiet savu pirmo pieprasījumu.
Importējiet kolekciju, ievadiet savu pārdošanas kanāla piekļuves datus un nosūtiet savu pirmo pieprasījumu dažu minūšu laikā — lai sāktu izpēti, nav nepieciešams integrācijas kods.