Siirry pääsisältöön

Integraation lisääminen

Kauppiaskohtaiset rajapintatunnukset mahdollistavat verkkokaupan integroinnin ulkoisiin järjestelmiin.

Päivitetty yli 2 kuukautta sitten

Integraation tunnusten lisääminen

  1. Siirry kohtaan Sovellukset > Integraatiot.

  2. Valitse Lisää integraatio ja anna sovellukselle seuraavat tiedot:

    • Nimi: Kuvaava nimi integraatiolle (esim. "Varastonhallintajärjestelmä").

    • Kuvaus: Lyhyt kuvaus integraation tarkoituksesta (esim. "Synkronoi varastotiedot ulkoisen järjestelmän kanssa").

    • Redirect URL: Sovelluksen uudelleenohjausosoite, johon käyttäjä ohjataan tunnistautumisen jälkeen (esim. https://oma-sovellus.fi/callback). Useamman osoitteen voit erottaa pilkulla.

  3. Tallenna integraatio, jolloin järjestelmä luo sinulle asiakastunnuksen (Client ID) ja salaisen avaimen (Client Secret). Nämä tunnukset tarvitaan tunnistautumiseen. Näet tunnukset valitsemalla integraation kohdalta Katso.

Tunnistautuminen (OAuth 2.0)

Vaihe 1: Ohjaa käyttäjä authorize endpointiin

  1. Ohjaa käyttäjä verkkokauppa-alustan authorize endpointiin, jossa käyttäjä antaa sovellukselle luvan käyttää rajapintaa.

  2. Esimerkki authorize endpoint -osoitteesta:

    GET /oauth/authorize  
    Host: account.finqu.com 
    Response-Type: code
    client_id=asiakastunnus&redirect_uri=https://oma-sovellus.fi/callback&scope=read_orders products_write&state=uniikki_tunniste

  3. Käyttäjän hyväksynnän jälkeen järjestelmä ohjaa käyttäjän takaisin määrittämääsi redirect URL-osoitteeseen ja liittää mukaan authorization coden:

    https://oma-sovellus.fi/callback?code=AUTHORIZATION_CODE&state=uniikki_tunniste

Vaihe 2: Hae access token authorization codella

  1. Käytä saatua authorization codea access tokenin hakemiseen lähettämällä pyyntö token endpointiin.

  2. Esimerkki token endpoint -pyynnöstä:

    POST /oauth/token  
    Host: account.finqu.com
    Content-Type: application/x-www-form-urlencoded  

    grant_type=authorization_code&  
    client_id=asiakastunnus&  
    client_secret=salainen_avain&  
    redirect_uri=https://oma-sovellus.fi/callback&  
    code=AUTHORIZATION_CODE

  3. Onnistuneen pyynnön jälkeen saat vastauksena access tokenin, jota käytetään kaikissa rajapintapyynnöissä:

    {  
      "access_token": "ACCESS_TOKEN",  
      "token_type": "Bearer",  
      "expires_in": 3600,  
      "scope": "read_orders write_products"  
    }

Vaihe 3. Hae kauppiaan tiedot resource endpointista

  1. Käytä saatua access tokenia kauppiaan tietojen hakemiseen resource endpointista.

  2. Esimerkki resource endpoint -pyynnöstä:

    GET /oauth2/resource  
    Host: account.finqu.com 
    Authorization: Bearer ACCESS_TOKEN

  3. Onnistuneen pyynnön jälkeen saat vastauksena kauppiaan tiedot, kuten API-osoitteen ja hallinnan osoitteen:

    {  
      "id": "12345",
      "merchant_name": "Esimerkki Kauppa",  
      "api_endpoint": "https://unity-2x2x.api.myfinqu.com",  
      "admin_endpoint": "https://unity-2x2x.myfinqu.com"  
    }

  4. Tallenna nämä tiedot sovellukseesi, jotta voit käyttää kauppiaan rajapintaa ja hallinnan osoitetta jatkossa.

Käyttöoikeudet (scopes)

Scopes määrittävät, mihin osiin rajapintaa integraatiolla on pääsy. Alla on lista käytettävissä olevista scopeista.

Scope

Kuvaus

analytics_read

Analytiikkatietojen lukeminen

analytics_write

Analytiikkatietojen muokkaaminen

catalog_read

Tuotekatalogin lukeminen

catalog_write

Tuotekatalogin muokkaaminen

checkouts_read

Kassaprosessien lukeminen

checkouts_write

Kassaprosessien muokkaaminen

customers_read

Asiakastietojen lukeminen

customers_write

Asiakastietojen muokkaaminen

discounts_read

Alennusten lukeminen

discounts_write

Alennusten muokkaaminen

domains_read

Domainien lukeminen

domains_write

Domainien muokkaaminen

emails_read

Sähköpostien lukeminen

emails_write

Sähköpostien muokkaaminen

feeds_read

Syötteiden lukeminen

feeds_write

Syötteiden muokkaaminen

files_read

Tiedostojen lukeminen

files_write

Tiedostojen muokkaaminen

inventories_read

Varastotietojen lukeminen

inventories_write

Varastotietojen muokkaaminen

marketing_read

Markkinointitietojen lukeminen

marketing_write

Markkinointitietojen muokkaaminen

media_read

Median lukeminen

media_write

Median muokkaaminen

payment_methods_read

Maksutapojen lukeminen

payment_methods_write

Maksutapojen muokkaaminen

pos_read

Myyntipisteiden lukeminen

pos_write

Myyntipisteiden muokkaaminen

products_read

Tuotteiden lukeminen

products_write

Tuotteiden muokkaaminen

profile

Kauppiaan profiilitiedot

sales_channel_read

Myyntikanavien lukeminen

sales_channel_write

Myyntikanavien muokkaaminen

sales_read

Myyntitietojen lukeminen

sales_write

Myyntitietojen muokkaaminen

settings_read

Asetusten lukeminen

settings_write

Asetusten muokkaaminen

shipping_methods_read

Toimitustapojen lukeminen

shipping_methods_write

Toimitustapojen muokkaaminen

staff_read

Henkilöstötietojen lukeminen

staff_write

Henkilöstötietojen muokkaaminen

themes_read

Teemojen lukeminen

themes_write

Teemojen muokkaaminen

themes_extend_read

Teemojen laajennusten lukeminen

themes_extend_write

Teemojen laajennusten muokkaaminen

Rajapintadokumentaatio

  1. Tarkemmat tiedot rajapinnan käytöstä, endpoint-osoitteista ja esimerkkipyynnöistä löydät rajapintadokumentaatiosta.

  2. Dokumentaatio on saatavilla osoitteessa: Rajapintadokumentaatio

Vastasiko tämä kysymykseesi?