Rajapinta - avaaminen ja hallinnointi

Rajapinnan avaaminen ja hallinnointi

Adensyn rajapinnan avulla voit yhdistää muita sovelluksia palveluumme. Tässä dokumentissa on kerrottu yleisesti rajapinnan mahdollisuuksista ja käyttöönotosta.

Rajapintayhteydet

Pääsy palvelun tietoihin täytyy avata luomalla rajapintayhteys. Rajapintayhteyksiä voi olla useita ja ne voivat olla aktiivisia (käytössä olevia) tai suljettuja. 

Huom!

Perustettuja rajapintayhteyksiä ei voi poistaa mutta ne voidaan sulkea, jolloin yhteys lakkaa toimimasta. Poistaminen on estetty, jotta ohjelmaan ei voi väliaikaisesti antaa pääsyä ilman, että se näkyy Adensy-tilin historiassa.

Rajapinnan avain ja salasana

Adensy antaa automaattisesti avaimen (apikoodi) ja salasanan (api-salasana) kun rajapinta perustetaan. Nämä näkyvät rajanpinnan tiedoissa, jotka saa auki avaamalla rajapinnan käyttöliittymästä.

Sallitut yhteydet ja resurssit

Rajapintayhteyteen tulee määrittää mitkä rajapinnan ovat sallittuja.

Rajapintoja ovat:

  1. Data-Api
  2. File-Api
  3. Website-Api

Data-api-rajapinnassa tulee erikseen määrittää mihin tietolähteisiin (resurssit) rajapinnalla on pääsy ja mitkä operaatiot ovat sallittuja.

  • Resursseja ovat mm. company (yritys), contactperson (kontakti), invoice (lasku) jne.
  • Operaatiot on jaoteltu seuraaviin ryhmiin: Luku (r), päivitys (u), lisäys (i) ja poisto (d).

Miksi resurssit tulee erikseen määrittää?

Näiden määritysten avulla yrityksesi pystyy rajaamaan ohjelmistokumppanille annetun pääsyn palvelun tietoihin. Jos yritykselläsi on useita ohjelmistokumppaneita, jotka tarvitsevat pääsyn palveluumme, voitte rajata pääsyn vain niihin tietoihin joihin on tarvetta. Voitte myös varmistua, että rajapinnan toteuttaja ei tee sellaisia operaatioita (esim. poisto tai päivitys) johon ei ole lupaa.

Rajapintayhteyden raportit

Adensy CRM pitää kirjaa rajapintakutsujen määristä. Näet raportit rajapintayhteys-lomakkeen alaosasta.