Mine otse põhilise sisu juurde
Postmanis on avatud Fabrixa API-päring — JSON-vormingus päringukorpus koos kahe autentimise päisega
Arendajad · Postmani kogumik

Impordi kogumik. Saavuta API viie minuti jooksul.

Valmis Postmani kogumik, mis sisaldab praktilisi näiteid Fabrixa-integratsiooni jaoks API-ga. Sisestage oma kasutajatunnused, klõpsake päringutel ja vaadake API-le saadud tegelikke vastuseid enne, kui kirjutate ühtegi rida integratsioonikoodi. Versioonidevaheline sünkroniseerimine – kogumik uueneb koos API-ga.

Postman v10+ · Kahe pealkirjaga autentimine · v2-integratsioon API

Mis on kollektsioonis

Iga lõpppunkt koos näidisandmetega.

Korraldatud kaustadesse ressursi järgi. Iga päring sisaldab valmis näitepõhist sisu, kaht eelnevalt seadistatud autentimise päist ning salvestatud näitevastust – nii saate enne päringu saatmist vastuse struktuuri eelvaadata.

Autentimine ja tooted
  • GET /ping — kontrolli autentimisandmeid
  • GET /tooted — nimekiri ja lehekülgede jagamine (SKU + variant_id)
  • Swaggeri viites esitatud täielikud väljaskeemid
Tellimused
  • POSTITUS /tellimused — tellimuse loomine
  • GET /orders/{id}/fulfillments — tootmise jälgimine
Stuudio ja veebihookid
  • GET /v2/studio/customizations/{key}/preview
  • Webhooki andmepakett + HMAC-kontroll (näide)
Importimine 30 sekundiga

Fail → Import → Lingi → kleebi URL.

01
Kogumiku importimine

Postmanis: File → Import → Link. Kleebi eespool asuvast allalaadimisnupust JSON-i URL. Postman lisab kogumiku – koos selle muutujatega – Teie töökeskkonda.

02
Ava vahekaart „Muutujad“

Kogumik sisaldab oma muutujaid — base_url on eelnevalt täidetud; access_token ja application_key on paigahoidjad. Eraldi keskkonnafaili pole vaja.

03
Kopeeri oma võtmed

Sisesta oma juhtpaneelis müügikanali rakenduse juurdepääsutoken ja rakenduse võti, vajuta nuppu „Salvesta“ ning iga päring autentifitseeritakse.

Keskkonnamuutujad

Mis on env-failis?.

Üks baas-URL, kaks autentimisandmet, mis on kogumisse sisse ehitatud. Arendage rakendus ühe müügikanali jaoks ning sisestage toote väljalaskmisel oma tegeliku kanali võtmed – sama kogum, samad päringud.

Kogumise muutujad
{
  "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"
}
Autentimine on eelnevalt seadistatud

Mõlemad autentimise päised on igas päringus eelnevalt määratud.

Iga päring sisaldab Authorization: Bearer {{access_token}} ja X-Application-Key: {{application_key}}, mis võetakse kogumimuutujatest — pole vaja iga päringu jaoks eraldi päiseid seadistada. Ühelt müügikanalilt teisele üleminek tähendab lihtsalt nende kahe muutuja muutmist: sama kogum, erinevad võtmed.

Näiteülesanded

Iga päringule on lisatud näidistekst ja salvestatud vastus.

Kogumik ei koosne ainult URL-i lühivormidest – iga päringu juures on valmis näite sisu, nii et saate vajutada nuppu „Saada“ ja näha tegelikke andmeid. Salvestatud näitevastused asuvad paneelis „Näited“, kust neid saab offline-režiimis vaadata.

GET /ping

Autentimise kontrollimine

Kinnitab esmalt, et teie rakenduse juurdepääsutoken ja rakenduse võti on kehtivad. Eduka tulemuse korral 200, kui pealkiri puudub, siis 401.

GET /tooted

Tooteid loetleda

Lehekülgedeks jaotatud kataloogi päring. Tagastab tooted lehekülghaaval lingide / meta / andmete pakendis, koos SKU-koodiga ja iga toote variandi ID-ga.

POST /tellimused

Tee tellimus

Näidistellimus ühe T-särgi tellimuse kohta, millel on allikas-PDF, kliendi- ja tarneaadress. Vajuta nuppu „Saada”, et vaadata loodud tellimust koos selle Fabrixa-tunnusega.

GET /tellimused/{id}/täitmised

Tootmise jälgimine

Kuvab eseme kaupa tootmisetappe (trükkimine, kinnitamine, pesemine, õmblemine) koos tellimuse staatustega „ootel”, „käimas”, „valmis” ja „tagasi lükatud”.

/studio/.../eelvaade

Stuudio eelvaade

Tagastab salvestatud Studio kohanduse renderdatud eelvaatepildi – lisa see otse ostukorvi pisipildiks.

Webhooki kontrollimine

Allkirja kontrollimine

Näide HMAC-SHA256-allkirja uuesti arvutamisest ja selle võrdlemisest x-webhook-signature’iga enne töötlemist.

Versioonihaldus

Kogu uueneb koos API-ga.

Iga API-väljalase sisaldab uuendatud kogumit samal URL-aadressil. Importige andmed uuesti, et saada uued lõpppunktid ja näiteandmed – teie salvestatud versioonis olevad olemasolevad päringud toimivad edasi, kuni vastav lõpppunkt tegelikult kasutuselt kõrvaldatakse.

Püsiv URL

Kogumiku JSON-i URL on püsiv. Uuesti importimisel laaditakse alla uusim versioon – URL ei muutu versioonide vahel kunagi.

Viide muudatuste loendile

Vaata muudatuste loend vastavate API versiooni märkuste kohta – mis muutus, mis lisati, mis on vananenud.

Vananenud funktsioonide kasutamise piiramise põhimõtted

Endpunktidele antakse 12-kuuline üleminekuperiood. Kogumik märgistab kasutusest kõrvaldatud päringud kirjelduses, nii et neid on raske märkamata jätta enne, kui midagi katki läheb.

KKK

„Postiljon“ kogumik, vastused

Kuidas importida Fabrixa Postmani kogumikku?

Valige Postmanis menüü „File“, seejärel „Import“ ja „Link“ ning kleepige kogumiku JSON-URL. Postman lisab kogumiku koos selle muutujatega teie töökeskkonda – väli „base_url“ on eeltäidetud, samas kui „access_token“ ja „application_key“ on asendusmärgid, mille peate asendama oma rakenduse juurdepääsutokeniga ja rakenduse võtmega.

Millised lõpppunktid kuuluvad Fabrixa Postmani kogumisse?

Kogumik hõlmab GET /ping-päringut autentimisandmete kontrollimiseks, GET /products-päringut kataloogi loetlemiseks ja lehekülgede jagamiseks, POST /orders-päringut tellimuse loomiseks, GET /orders/{id}/fulfillments-päringut tootmise jälgimiseks, Studio eelvaate lõpppunkti ning töötavat näidet veebihooki allkirja kontrollimisest. Kogumik on loodud v2 Integration API jaoks ning selle kasutamiseks on vaja Postman v10 või uuemat versiooni.

Kuidas on autentimine seadistatud Fabrixa Postmani kogumikus?

Iga kogumisse kuuluv päring sisaldab juba kahte nõutavat päist — Authorization: Bearer {{access_token}} ja X-Application-Key: {{application_key}} —, mis on võetud kogumi muutujatest. Rakenduse juurdepääsutokeni ja rakenduse võtme kleepimine nendesse muutujatesse autentib iga päringu korraga, ilma et iga päringu jaoks oleks vaja eraldi seadistusi teha.

Kas Fabrixa Postmani kogumik uueneb, kui API muutub?

Jah — iga API-väljalase sisaldab uuendatud kogumit samal püsival URL-aadressil, mistõttu uuesti importimisel laaditakse alla uusimad lõpppunktid ja näidisandmed. Lõpppunktidele kehtib 12-kuuline kasutusest kõrvaldamise periood ning kogum märgistab kasutusest kõrvaldatud päringud oma kirjelduses enne, kui midagi enam ei tööta.

Mida tagastab päring GET /orders/{id}/fulfillments?

See kuvab esitatud tellimuse iga toote tootmisstaatuse, hõlmates selliseid etappe nagu trükkimine, parandamine, pesemine ja õmblemine, mille staatuseks on vastavalt „ootel”, „käimas”, „valmis” või „tagasi lükatud”. Postmani kogumik sisaldab praktilist näidet, mis võimaldab vastuse struktuuri üle vaadata enne selle integreerimist süsteemi.

Lae alla ja alusta

Lae kogumik alla. Saada oma esimene päring.

Impordi kollektsioon, sisesta oma müügikanali kasutajatunnused ja saada oma esimene päring mõne minutiga — uurimise alustamiseks ei ole vaja integratsioonikoodi.