Revial
Integraatiot

Revial API: usein kysytyt kysymykset

Mikä Revialin API on, miten API-avaimet toimivat, mitä tietoja sillä saa ja mitä tarkistaa, jos se ei toimi.

Revialin API:n avulla toinen järjestelmä voi hakea organisaatiosi tapaamistiedot Revialista automaattisesti. Esimerkiksi raportointityökalu voi hakea kaikki viikon tapaamisyhteenvedot ilman, että kukaan kopioi niitä käsin.

Tekninen dokumentaatio: rajapinnat, parametrit ja vastausten muodot löytyvät Revialin API-dokumentaatiosta. Linkki on myös kohdassa Asetukset → Organisaatio → API-avaimet.

Perusteet

Mikä on API?

Tapa, jolla ohjelma voi pyytää tietoja toiselta ohjelmalta. Sen sijaan, että ihminen avaisi Revialin ja kopioisi tietoja, ohjelma pyytää ne suoraan Revialista.

Tarvitaanko teknistä osaamista?

Avaimen luomiseen ei. Tietojen liittämiseen toiseen työkaluun tarvitaan yleensä oma IT-tiimi, integraatiokumppani tai automaatiotyökalu kuten Zapier tai Make.

Mistä tekniset henkilöt löytävät ohjeet?

Revialin API-dokumentaatiosta. Katso myös alla oleva kohta Kehittäjille.

API-avaimet

Mikä on API-avain?

Salasana, jolla toinen ohjelma pääsee organisaatiosi Revial-tietoihin. Käsittele sitä kuin salasanaa.

Mistä avaimen saa?

Avaa Asetukset → Organisaatio → API-avaimet ja valitse Luo avain. Anna avaimelle nimi, joka kertoo, mihin sitä käytetään, esimerkiksi "Tietovarastovienti".

En näe API-avaimet-kohtaa asetuksissa.

Vain organisaation omistaja näkee API-avaimet ja voi luoda niitä. Pyydä omistajaa luomaan avain. Katso Käyttäjäroolit.

Miksi avain näytetään vain kerran?

Revial ei tallenna itse avainta, vaan ainoastaan sen tunnisteen, joten avainta ei voi näyttää uudelleen. Kopioi se heti, kun se on luotu. Jos avain katoaa, luo uusi ja kumoa vanha.

Miksi avaimia voi olla useita?

Jotta jokaisella työkalulla on oma avaimensa. Kun yksi työkalu poistuu käytöstä, kumotaan vain sen avain, ja muut jatkavat toimintaansa.

Mitä tapahtuu, kun avain kumotaan?

Se lakkaa toimimasta heti. Kumottua avainta ei saa takaisin, mutta uuden voi luoda milloin tahansa.

Vanheneeko avain?

Ei. Avain toimii, kunnes se kumotaan.

Mihin tietoihin avaimella pääsee?

Samoihin tapaamisiin, jotka avaimen luonut henkilö näkee Revialissa. Jos tämä henkilö poistetaan Revialista, hänen avaimensa lakkaavat toimimasta.

Missä avainta kannattaa säilyttää?

Salasanojen hallinnassa tai järjestelmän salaisuuksien säilössä. Ei sähköpostissa, chatissa eikä jaetuissa dokumenteissa.

Mitä API kattaa

API:lla voi:

  • hakea tapaamisten yhteenvedot
  • hakea tapaamisten litteroinnit
  • rajata tapaamisia myyjän, osallistujan tai yrityksen mukaan
  • hakea vain edellisen synkronoinnin jälkeen uudet tai muuttuneet tapaamiset
  • päivittää tapaamisen mukautettuja kenttiä
  • pyytää tapaamiselle uuden yhteenvedon

API ei kata:

  • tapaamisia, joilla ei ole vielä yhteenvetoa
  • ääni- ja videotallenteita
  • CRM-tietoja, analytiikkaa tai kalenteritietoja
  • tapaamisten luomista tai poistamista
  • ilmoituksia tietojen muuttumisesta (webhookit)
  • rajattuja avaimia, esimerkiksi vain lukuoikeuden avaimia

Tarvitsetko jotain, mitä listalla ei ole? Ota yhteyttä support@revial.ai ja kerro, mitä yrität saada aikaan.

Kehittäjille

Lähetä avain bearer-tunnisteena jokaisessa pyynnössä:

Authorization: Bearer rvl_live_...
  • Sivutus: listat palauttavat kentän next_cursor. Lähetä se takaisin parametrina cursor, kunnes arvo on null.
  • Inkrementaalinen synkronointi: anna parametri updated_after edellisen synkronoinnin ajankohdalla, niin saat vain muuttuneet tapaamiset.
  • Pyyntörajoitus: 120 pyyntöä minuutissa avainta kohden. Rajan ylittyessä API vastaa koodilla 429 ja otsakkeella Retry-After, joka kertoo odotusajan sekunteina.
  • Määrittely: OpenAPI-dokumentti on osoitteessa https://api.revial.ai/v1/openapi.json, ja sen voi antaa suoraan asiakaskirjaston generaattorille.

Jos jokin ei toimi

Avain ei toimi.

Tarkista, että avain on kopioitu kokonaan ja ettei sitä ole kumottu. Jos avaimen luonut henkilö on poistettu Revialista, luo uusi avain.

Tulee virhe liian monesta pyynnöstä.

Jokaisella avaimella voi tehdä 120 pyyntöä minuutissa. Odota Retry-After-otsakkeen kertoma aika ja yritä uudelleen.

Jokin muu ongelma?

Ota yhteyttä support@revial.ai. Kerro, mitä yritit tehdä ja minkä virheilmoituksen sait.

Tällä sivulla