MerchandAisen kehittäjäalusta
Yhdistä työnkulkusi MerchandAiseen.
Löydä API-dokumentaatio ja OpenAPI-määritykset personoitujen tuotteiden työnkulkuihin. Yhdistä verkkosivut, yhteisöt, toimittajatoiminnot tai yritystilit yhteisiin suunnittelu-, tarjous- ja tilaustietoihin.
Valitse projektisi tarvitsema yhteys
Arvioi alla olevien viitteiden avulla päätepisteet, pyyntömuodot ja valtuutusvaatimukset. Julkiset määritykset tukevat suunnittelua ja asiakasohjelmien generointia. Operatiivinen käyttö riippuu APIsta, tilistä ja ympäristöstä.
Kun MerchandAise käsittelee ostajan maksutapahtuman, Hutter Products GmbH toimii sopimuksen myyjänä ja maksutapahtuman vastuullisena myyjänä (Merchant of Record) MerchandAise-brändin alla. Toimittajan henkilöllisyys ja yhteystiedot pysyvät yksityisinä, ellei niiden ilmoittamista vaadita. Tuotanto edellyttää edelleen digitaalisen vedoksen hyväksyntää, vahvistettua valmistettavuutta, pakollisia teknisiä tarkistuksia ja juuri hyväksyttyyn tilaukseen sovellettavia näytehyväksyntöjä.
01 — Rajapintamääritykset
API- ja integraatiorajapinnat
01
API-dokumentaatio ja OpenAPI
Etsi avustajien työkalujen ja suunnitteluistuntojen API-viite. Valitse sitten työnkulkuusi sopiva yhteisö-, toimittaja- tai yritysmääritys.
Toteutusopas
Lue avustajatyökalujen ohjeetKoneluettava määritys
Avustajatyökalujen OpenAPI JSON/api/docs/openapi.jsonJulkinen viite avustajien ja työkalujen rajapinnoille. Tuotantokäyttö ja tilauksiin vaikuttavat toiminnot edellyttävät yhä soveltuvaa valtuutusta.
02
Yhteisö-API
Yhdistä seuran tai yhteisön sivusto julkisiin yhteisötietoihin, suunnitelmien lähettämiseen, äänestämiseen ja tilauksen hyväksyntään siirtymiseen.
- Mitä määritys kattaa
- Julkinen yhteisön asiayhteys, suunnitelmajulkaisut ja äänet, listausten julkaisu, odottavat tilaukset sekä yhteisön omistajan hyväksyntä tai hylkäys.
- Käytännöllinen lähtökohta
- Lue julkinen yhteisön asiayhteys seuran sivustolle. Kartoita sitten jäsenistunnon tai omistajan oikeuksia vaativat toiminnot ennen suunnitelmien lähettämistä tai kassalle siirtymistä.
- Käyttöoikeus
- Määritys on julkinen. Julkisilla lukupyynnöillä, jäsentoiminnoilla ja vain omistajalle sallituilla toiminnoilla on eri valtuutusvaatimukset. Noudata jokaisen päätepisteen turvallisuussääntöjä.
Koneluettava määritys
Yhteisön OpenAPI JSON/api/v1/community/public/openapi/v1Julkinen versioitu määritys kauppaupotuksiin, yhteisöjen löytämiseen ja kieliversion säilyttäviin siirtymiin.
03
Toimittaja-API
Yhdistä hyväksyttyjen toimittajien järjestelmät julkaistuihin tuotantopaketteihin, perehdytystilaan ja ERP- tai PLM-webhook-työnkulkuihin.
- Mitä määritys kattaa
- Toimittajan perehdytystila, julkaistut tuotantopaketit, kirjatut aineistolataukset, analytiikka, webhook-tilaukset ja synkronoinnin tarkistuspisteet.
- Käytännöllinen lähtökohta
- Suunnittele ERP- tai tuotteen elinkaarenhallintajärjestelmäsi yhteys Toimittajakeskukseen. Tarkista webhookien tietosisällöt, uudelleenyritykset ja synkronointitilanne ennen osoitetun tilauksen käsittelyä.
- Käyttöoikeus
- Lue OpenAPI-määritys ilman kirjautumista. Operatiiviset pyynnöt edellyttävät asianmukaista toimittajatiliä ja oikeuksia. Julkinen dokumentaatio ei liitä toimittajaa verkostoon eikä anna pääsyä toisen toimittajan tietoihin.
Koneluettava määritys
Toimittajan OpenAPI JSON/api/v1/supplier/openapi/v1Julkinen määritys suunnittelua ja asiakasohjelmien generointia varten. Toimittajan operatiivinen käyttö edellyttää käyttöoikeuksia.
04
Yritysten tunnistautumis-API
Yhdistä hyväksytyt yritystyötilat kertakirjautumiseen, käyttäjien ja ryhmien hallintaan sekä tunnistautumisen tarkistuslokiin.
- Mitä määritys kattaa
- OpenID Connect (OIDC) -kertakirjautuminen, SCIM-käyttäjien ja -ryhmien elinkaaritoiminnot, SCIM-tunnisteiden vaihto sekä käyttäjähallinnan tarkistustapahtumat.
- Käytännöllinen lähtökohta
- Yhdistä tunnistuspalvelusi hyväksyttyyn työtilaan. Suunnittele kirjautuminen sekä käyttäjien lisääminen ja poistaminen. Vahvista sitten ryhmävastaavuudet ja tarkistuslokit sovitussa testiympäristössä.
- Käyttöoikeus
- Yritystunnistuksen määritys on suojattu. Ota yhteyttä integraatiotiimiin arvioidaksesi työtilan ja käyttöoikeusvaatimukset ennen toteutusta. Yritystunnistus ei ole tavallisten tuoteostosten edellytys.
Koneluettava määritys
Yritystunnistuksen OpenAPI JSON/api/v1/enterprise/identity/openapi/v1Suojattu määritys hyväksytyille yritystyötiloille. Pyydä käyttöoikeus ennen tämän päätepisteen käyttämistä.
Suunnittele integraatio02 — Toteutusopas
Valitse määritys ennen koodia
- 01
Kartoita käyttäjän polku
Päätä, kuka siirtyy työnkulkuun ja missä: upotetun kaupan ostaja, hyväksytty toimittaja, yrityskäyttäjä tai nimenomaisella valtuutuksella toimiva avustaja.
- 02
Vahvista käyttöoikeusraja
Käytä julkisia määrityksiä arviointiin ja asiakasohjelmien generointiin. Vahvista sitten tunnistetiedot, käyttöoikeusalueet, ympäristöt, paluukutsut ja suojatut päätepisteet ennen toteutusta.
- 03
Todista tilan jatkuvuus
Testaa, että suunnitelmat, tarjoukset, hyväksynnät, virheet ja tilaussiirtymät säilyvät ajantasaisina koko integraatiossa, myös uudelleenyrityksissä ja palautuspoluilla.
03 — Mitä jokaisen integraation on säilytettävä
Mitä jokaisen integraation on säilytettävä
Yksi versioitu tila
Suunnitelma, ostoaikomus, toimittajan vahvistama tarjous, hyväksyntä ja tilaustilanne pysyvät yhteydessä toisiinsa. Vanhentuneiden muutosten on tuotava näkyviin uusi tarjouspyyntö tai arviointitila.
Kaupallisten ja toimittajatietojen yksityisyys
MerchandAise säilyy ostajalle näkyvänä myyjänä ja tuesta vastaavana tahona. Toimittajien henkilöllisyyksiä, yhteystietoja ja sisäisiä tietoja ei paljasteta julkisissa integraatioissa.
Hyväksyntä ennen tuotantoa
3D-näkymä ei ole fyysistä näyttöä. Vahvistettu tarjous kertoo mahdollisista asiakasnäytteistä, niiden kustannuksista, rajoituksista ja aikataulusta. Hyväksy täsmällinen digitaalinen vedos ja suorita pakolliset tekniset tarkistukset sekä vaadittu tai valittu näytteen hyväksyntä ennen massatuotantoa. Hyväksyttyjen tilausten nykyiset vaatimukset pysyvät sitovina.
04
Ennen tuotantoliikennettä
Julkaistu OpenAPI-tiedosto on suunnittelun apuväline, ei lupaus anonyymistä tuotantokäytöstä. Arvioimme ympäristöt, tunnistetiedot, virheiden käsittelyn ja toimintavastuut ennen käyttöönottoa.
Käyttöoikeudet ja ympäristöt
Vahvista määritysversio, hyväksytty työtila, tunnistautumisen käyttöoikeusalueet, testiympäristö, tuotantotunnisteet ja paluukutsujen kohteet.
Virheet ja palautuminen
Määritä uudelleenyritykset, idempotenssi, aikakatkaisut, asiakkaalle näkyvät virheet, seurattavuus, tukivastuut ja palautus ennen julkaisua.
Koko polun näyttö
Vahvista tarkoitettu polku testiympäristössä aloituksesta ja tilamuutoksesta tarjoukseen, hyväksyntään, siirtymään ja palautumiseen.
Usein kysyttyä
Mistä tuote-APIsta kannattaa aloittaa?
Aloita käyttäjästä ja tilasiirtymästä. Käytä yhteisöupotuksia ostajille suunnattuihin seura- ja yhteisöpolkuihin, toimittajatoimintoja hyväksyttyihin tarjontapuolen työnkulkuihin, yritystunnistusta SSO:hon ja SCIMiin sekä avustajatyökaluja vain nimenomaisesti valtuutettuihin tekoälyn ohjaamiin toimintoihin.
Tarkoittaako julkinen määritys julkista tuotantokäyttöä?
Ei. Julkinen OpenAPI-määritys tukee löytämistä, arkkitehtuurin arviointia ja asiakasohjelmien generointia. Tuotantotunnisteet, kirjoitustoiminnot, toimittajatyönkulut, yritystunnistus ja avustajan suorittamat toiminnot voivat silti edellyttää hyväksyttyä työtilaa ja rajattua valtuutusta.
Voiko integraatio paljastaa toimittajia tai ohittaa hyväksynnät?
Ei. Toimittajan henkilöllisyys ja yhteystiedot pysyvät yksityisinä paitsi silloin, kun niiden ilmoittamista vaaditaan. MerchandAise vastaa asiakassuhteesta, ja tilauksiin vaikuttavien toimintojen on säilytettävä määritetyt digitaalisen vedoksen, teknisten tarkistusten ja tilauskohtaisten näytteiden hyväksyntävaatimukset.
Suunnittele integraatiosi kanssamme.
Kerro, kuka integraatiota käyttää, mitä tilaa luetaan tai muutetaan ja missä käyttökokemus sijaitsee. Kartoitamme kanssasi määrityksen, käyttöoikeusmallin ja turvallisimman käyttöönottopolun.