Fenerum API:n käytön aloitus

Tervetuloa Fenerum API -dokumentaatioon. Tämä opas auttaa sinua aloittamaan Fenerumin integroinnin sovellukseesi.

Pika-aloitus

Luo API-tunnus - Luo todennustietosi
Tee ensimmäinen pyyntö - Testaa API-yhteytesi
Tutustu APIin - Selaa käytettävissä olevia päätepisteitä ja resursseja

Interaktiivinen API-selain

Fenerum tarjoaa interaktiiviset työkalut API:n tutkimiseen ja testaamiseen:

API Browser: https://app.fenerum.com/api/v1/
Swagger Console: https://app.fenerum.com/api/swagger/

Swagger Console sisältää jokaisella päätepisteellä "Try it out" -painikkeen, jonka avulla voit tehdä oikeita API-kutsuja suoraan selaimestasi.

Keskeiset oppaat

Ennen kuin sukellat APIin, suosittelemme lukemaan nämä oppaat:

Todennus - Opi, miten todennat pyyntösi
Virheet - Ymmärrä virhevastaukset ja tilakoodit
Sivutus - Työskentele sivutettujen listavastausten kanssa
Suodatus - Rajaa listan tuloksia kyselysuodattimilla
Rajoitukset - Nopeusrajoitukset ja parhaat käytännöt
Lokitus - Vianmääritys ja API-käytön seuranta

Yleiset työnkulut

Näin toteutat yleisiä integraatiokuvioita:

Maksujen vastaanottaminen - Integroi maksujen käsittely
Tyypillinen työnkulku - Käsittele tilauksia ja laskutusta

API-resurssit

Tutustu koko API-viitteeseen osa-alueittain ryhmiteltynä.

Asiakkaat

Tilit - Hallitse asiakastilejä
Vastaanottajat - Ilmoitusten vastaanottajat per tili
Suoraveloitusvelalliset - Pankkisuoraveloituksen sopimukset

Tilaukset ja suunnitelmat

Tilaukset - Käsittele toistuvaa laskutusta
Tilausmuutokset - Ajoita tason nostoja, tason laskuja ja aikaistettuja uusintoja
Suunnitelmat - Tuotepaketit, joissa on hinnoittelumuunnelmia
Suunnitelman ehdot - Suunnitelmaan liitetyt hinnoittelumuunnelmat
Sopimukset - Tilikohtaiset hinnoittelun poikkeukset
Sopimustasot - Volyymiperusteinen hinnoittelu sopimuksessa
Churn-syyt - Muokattavat peruutustunnisteet

Laskutus ja laskut

Laskut - Laaditut laskut
Laskurivit - Laadittujen laskujen rivit
Luonnoslaskurivit - Odottavat rivit
Luonnoslaskurivien tuotteet - Tuoteluetteloon pohjautuvat luonnosrivit
Verkkolaskun kenttäkartoitus - Kohdista Fenerumin laskukentät verkkolaskuoperaattorillesi

Tuoteluettelo

Tuotteet - Määrittele tuoteluettelosi
Tuotteiden hinnoittelut - Valuutta- ja jaksokohtaiset hintapisteet
Liikevaihtoryhmät - Ryhmittele liikevaihto MRR/ARR-leikkauksiin

Maksut

Maksukortit - Hallitse maksutapoja

Raportointi ja tapahtumat

Tapahtumat - Tilausten taloustapahtumat
Raportit - Tallennetut KPI-näkymät
KPI:t - Raporttien taustalla olevat mittarimäärittelyt
Tilitapahtumat - Pankkitilitapahtumat

Kirjanpito

Pankkitilit - Määritetyt tilitystilit
Kuitit - Kulutositteet täsmäytystä varten
Ostolaskut - Toimittajiltasi saapuvat laskut
ERP-tilit - Tilikartan tilit
ERP-tilirivit - Pääkirjakirjaukset
ERP-tilibudjetit - Tilikohteiden/kausien budjetoidut määrät
ERP-ALV-koodit - ALV-koodit ERP:stäsi

Webhookit

Webhookit - Vastaanota reaaliaikaisia ilmoituksia
Webhook-paluukutsut - Asynkronisten tapahtumien sanomien viite
Webhook-tapahtuman metatiedot - Toimituskohtainen audit-loki

Organisaatio

Liiketoimintayksiköt - Maakohtaiset juridiset yksiköt
Organisaation jäsenet - Organisaatioosi liitetyt käyttäjät

Itsepalvelu

Itsepalvelu - Julkiset, todennusta vaatimattomat rekisteröintipäätepisteet

Muut

Muut päätepisteet - Haku, ERP-tuonnit, dokumenttien lataukset, viennit ja kertaluonteiset raportit

Perus-URL

Kaikki API-pyynnöt tulee tehdä osoitteeseen:

https://app.fenerum.com/

Todennus

Lisää API-tunnus jokaiseen pyyntöön:

Authorization: Token <your-token>

Katso todennusopas tarkempia asennusohjeita varten.

Tarvitsetko apua?

Jos kohtaat ongelmia tai sinulla on kysyttävää:

Tarkista oppaamme yleisimpiin ratkaisuihin
Tutustu virhevastauksiin vianmääritystä varten
Ota yhteyttä: support@fenerum.com

Autamme sinua onnistumaan integraatiossa!

API Documentation