API-dokumentaatio

Yleiskatsaus Maventa verkkolaskutuksesta
Integraatio-opas
SOAP API
REST API
Swagger

Integraatioprosessin vaiheet

1. Integraattori luo testitilin osoitteessa http://testing.maventa.com

• Integraattori ilmoittaa perustetusta testitilistä osoitteeseen integrations@maventa.com
• Maventa luo testipuolen Vendor API -avaimen ja toimittaa sen integraattorille

2. Kun integraatio on valmis ja integraattori haluaa siirtyä tuotantoon

• Maventa tekee perusteellisen integraation validoinnin
• Sopimusten allekirjoitus

3. Integraattori rekisteröityy tuotantoon osoitteessa secure.maventa.com

• Maventa muuttaa tilin PARTNER-tiliksi ja toimittaa tuotantopuolen Vendor API -avaimen
• Integraattori implementoi integraation tuotantopuolelle

4. Maventa suorittaa tuotantoseurantaa, jotta varmistutaan integraation toimivuudesta tuotantoympäristössä

HUOM! Testiympäristön kautta lähetetyt verkko- tai paperilaskut eivät lähde testiympäristön ulkopuolelle, eli laskuja ei toimiteta ilmoitetulle vastaanottajalle, vaikka laskun tilaksi tulee Lähetetty / Sent.
Otathan kuitenkin huomioon, että laskuaineistolla ilmoitettuun sähköpostiin voi kuitenkin lähteä sekä lasku, että laskuilmoitus, joten kaikissa testilähetyksissä kannattaakin käyttää esimerkiksi omaa tai yrityksen sähköpostia.

Authentication - Tunnistautuminen

Maventan REST rajapinnassa tunnistautuminen tehdään hyödyntäen oauth2 standardin mukaista tokenia. Kaikki rajapinnan toiminnallisuudet vaativat voimassaolevan oauth2 bearer tokenin.

The POST /oauth2/token method is called using the company's credentials:

• client_id is the company_id
• client_secret is the user_api_key
• vendor_api_key

Esimerkki tokenin noudosta Maventan rajapinnassa:

curl --location --request POST 'https://ax-stage.maventa.com/oauth2/token' \
--header 'Content-Type: multipart/form-data' \
--form 'grant_type="client_credentials"' \
--form 'client_id="xxxxxxxxxxxx"' \
--form 'client_secret="xxxxxxxxxxxx"' \
--form 'scope="eui"' \
--form 'vendor_api_key="xxxxxxxxxxxx"