Siirry pääsisältöön
Postman-sovelluksessa avoinna oleva Fabrixa API -pyyntö — JSON-tilauspayload, jossa on kaksi todennusotsikkoa
Kehittäjät · Postman-kokoelma

Tuo kokoelma. Viidessä minuutissa APIssa.

Valmiiksi koottu Postman-kokoelma, joka sisältää käytännön esimerkkejä Fabrixa Integration API:sta. Syötä tunnuksesi, selaa pyyntöjä ja katso todellisia vastauksia API:ltä ennen kuin kirjoitat yhtään riviä integraatiokoodia. Versioita seurataan – kokoelma päivittyy, kun API päivittyy.

Postman v10+ · Kahden otsikon todennus · v2 Integration API

Mitä kokoelma sisältää

Jokainen endpoint, mukana esimerkkipayloadit.

Järjestetty kansioihin resurssin mukaan. Jokainen pyyntö sisältää valmiin esimerkkipyynnön, kaksi valmiiksi asetettua todennusotsikkoa sekä tallennetun esimerkkivastauksen – näin voit tarkastella vastauksen rakennetta etukäteen ennen pyynnön lähettämistä.

Autentikointi ja tuotteet
  • GET /ping — tunnistetietojen tarkistaminen
  • GET /products — luettelo ja sivutus (SKU + variant_id)
  • Swagger-viitteessä olevat täysimittaiset kenttäkaaviot
Tilaukset
  • POST /orders — luo tilaus
  • GET /orders/{id}/fulfillments — tuotannon seuranta
Studio ja webhookit
  • GET /v2/studio/customizations/{key}/preview
  • Webhook-payload + HMAC-todennus (esimerkki)
Tuo tiedosto 30 sekunnissa

Tiedosto → Tuo → Linkki → liitä URL-osoite.

01
Tuo kokoelma

Postmanissa: File → Import → Link. Liitä yllä olevan latauspainikkeen JSON-URL. Postman lisää kokoelman – muuttujineen – työtilaasi.

02
Avaa Muuttujat-välilehti

Kokoelmaan kuuluu omat muuttujansa — base_url on esitäytetty; access_token ja application_key ovat paikkamerkkejä. Erillistä ympäristötiedostoa ei tarvita.

03
Liitä avaimesi

Syötä hallintapaneelissasi myyntikanavan sovelluksen pääsytunnus ja sovelluksen avain, paina Tallenna, ja jokainen pyyntö todennetaan.

Ympäristömuuttujat

Mitä env-tiedosto sisältää.

Yksi perus-URL ja kaksi tunnistetietoa, jotka on sisällytetty kokoelmaan. Kehitä sovellus yhtä myyntikanavaa varten ja liitä sitten tuotantoympäristön avaimet julkaisun yhteydessä — sama kokoelma, samat pyynnöt.

Kokoelman muuttujat
{
  "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"
}
Todennus on esiasetettu

Molemmat todennusotsikot, jotka on määritetty valmiiksi jokaisessa pyynnössä.

Jokaiseen pyyntöön liittyy Authorization: Bearer {{access_token}} ja X-Application-Key: {{application_key}}, jotka haetaan kokoelman muuttujista — pyyntökohtaista otsikkokonfiguraatiota ei tarvita. Siirtyminen yhdestä myyntikanavasta toiseen tapahtuu yksinkertaisesti muokkaamalla näitä kahta muuttujaa: sama kokoelma, eri avaimet.

Esimerkkejä ratkaisuineen

Jokaiseen pyyntöön sisältyy esimerkki pyyntötekstistä ja tallennettu vastaus.

Kokoelma ei koostu pelkästään URL-lyhenteistä — jokaisella pyynnöllä on valmis esimerkkiteksti, joten voit painaa Lähetä-painiketta ja nähdä todellisia tietoja. Tallennetut esimerkkivastaukset löytyvät Esimerkit-paneelista, josta niitä voi tarkastella myös offline-tilassa.

GET /ping

Vahvista tunnistautuminen

Varmistaa ensimmäisenä, että sovelluksen pääsytunnus ja sovellusavain ovat voimassa. Palauttaa koodin 200, jos pyyntö onnistuu, ja koodin 401, jos jokin otsikko puuttuu.

GET /products

Luettele tuotteet

Sivutettu tuoteluettelopyyntö. Palauttaa tuotteet sivu kerrallaan links/meta/data-kääreessä, sisältäen jokaiselle tuotteelle SKU-tunnuksen ja varianttitunnuksen.

POST /orders

Tee tilaus

Esimerkki yhden kappaleen T-paita-tilauksesta, jossa on lähde-PDF, asiakkaan tiedot ja toimitusosoite. Napsauta Lähetä-painiketta nähdäksesi luodun tilauksen ja sen Fabrixa-tunnuksen.

GET /orders/{id}/fulfillments

Tuotannon seuranta

Näyttää tilatun tilauksen tuotantovaiheet tuotekohtaisesti (tulostus, kiinnitys, pesu, ompelu) sekä niiden tilat: odottava, käynnissä, valmis ja hylätty.

/studio/.../preview

Studion esikatselu

Palauttaa tallennetun Studio-mukautuksen renderoidun esikatselukuvan — voit lisätä sen suoraan ostoskorin pikkukuvaan.

Webhook-vahvistus

Allekirjoituksen tarkistus

Esimerkki HMAC-SHA256-allekirjoituksen uudelleenlaskemisesta ja sen vertaamisesta x-webhook-signature-arvoon ennen käsittelyä.

Versiointi

Kokoelma päivittyy samaan aikaan kuin API.

Jokaisen API-julkaisun yhteydessä päivitetyn kokoelman voi ladata samasta URL-osoitteesta. Tuo kokoelma uudelleen, jotta saat käyttöön uudet päätepisteet ja esimerkkipayloadit — tallennetussa versiossasi olevat olemassa olevat pyynnöt toimivat edelleen, kunnes kyseinen päätepiste poistuu käytöstä.

Vakaa URL-osoite

JSON-kokoelman URL-osoite on pysyvä. Uudelleentuonti hakee uusimman version — URL-osoite ei muutu julkaisujen välillä.

Changelog

Katso changelog katso vastaavat API-version muistiinpanot — mitä on muutettu, mitä on lisätty ja mitkä ominaisuudet ovat poistumassa käytöstä.

Vanhentamiskäytäntö

Endpointeille myönnetään 12 kuukauden siirtymäaika. Kokoelma merkitsee vanhentuneet pyynnöt kuvaukseen, joten niitä on vaikea jättää huomaamatta ennen kuin järjestelmässä ilmenee vikoja.

Usein kysytyt kysymykset

Postman-kokoelma, vastaukset

Miten voin tuoda Fabrixa Postman -kokoelman?

Valitse Postmanissa File, sitten Import, sen jälkeen Link ja liitä kokoelman JSON-URL. Postman lisää kokoelman ja sen muuttujat työtilaasi — fieldi base_url on jo täytetty, kun taas access_token ja application_key ovat paikkamerkkejä, jotka korvaat omalla sovelluksen pääsytunnuksellasi ja sovelluksen avaimellasi.

Mitkä päätepisteet sisältyvät Fabrixa Postman -kokoelmaan?

Kokoelma sisältää GET /ping -pyynnön tunnistetietojen vahvistamiseen, GET /products -pyynnön tuoteluettelon luettelointiin ja sivutukseen, POST /orders -pyynnön tilauksen luomiseen, GET /orders/{id}/fulfillments -pyynnön tuotannon seurantaan, Studio-esikatselupäätteen sekä toimivan esimerkin webhook-allekirjoituksen vahvistamisesta. Kokoelma on kehitetty v2 Integration API:tä varten ja vaatii Postmanin version 10 tai uudemman.

Miten todennus on määritetty Fabrixa Postman -kokoelmassa?

Jokaisessa kokoelman pyynnössä on jo mukana kaksi vaadittua otsikkoa — Authorization: Bearer {{access_token}} ja X-Application-Key: {{application_key}} — jotka haetaan kokoelman muuttujista. Sovelluksen pääsytunnuksen ja sovelluksen avaimen liittäminen näihin muuttujiin todentaa jokaisen pyynnön kerralla, ilman pyyntökohtaisia asetuksia.

Päivittyykö Fabrixa Postman -kokoelma, kun API muuttuu?

Kyllä — jokainen API-julkaisu sisältää päivitetyn kokoelman samassa pysyvässä URL-osoitteessa, joten uudelleen tuonnin yhteydessä ladataan uusimmat päätepisteet ja esimerkkipaketit. Päätepisteille myönnetään 12 kuukauden siirtymäaika, ja kokoelma merkitsee vanhentuneet pyynnöt niiden kuvauksessa ennen kuin toiminnallisuus lakkaa toimimasta.

Mitä GET /orders/{id}/fulfillments -pyyntö palauttaa?

Se hakee tehdyn tilauksen tuotantotilan tuotekohtaisesti, kattaen vaiheet kuten painatus, kiinnitys, pesu ja ompelu, joista jokainen ilmoitetaan tilassa ”odottaa”, ”käynnissä”, ”valmis” tai ”hylätty”. Postman-kokoelmaan sisältyy esimerkki, jonka avulla vastauksen rakenne voidaan tarkistaa ennen kuin se liitetään integraatioon.

Lataa ja aloita

Hanki kokoelma. Lähetä ensimmäinen pyyntösi.

Tuo kokoelma, syötä myyntikanavan tunnukset ja lähetä ensimmäinen pyyntösi muutamassa minuutissa — tutustumisen aloittamiseen ei tarvita integrointikoodia.