Creamailerin REST API antaa lähes rajattoman mahdollisuuden Creamailerin hyödyntämiseen. Sen avulla Creamailerin voi integroida suoraan mihin tahansa tietokantaan tai järjestelmään kuten vaikkapa CMS:iin, CRM:iin, verkkokauppaan tai blogiin. API:n käyttäminen vaatii ohjelmointitaitoja, joten API:in liittyvä ohjeistus on suunnattu ainoastaan ohjelmoijille. Tällä hetkellä API:n avulla voidaan hakea, lisätä, muokata ja poistaa postituslistoja sekä niiden tilaajia.
Suosittelemme, että kaikki aiheesta kiinnostuneet liittyvät API-postituslistalle, johon lähetämme tietoja integrointeihin ja rajapintoihin liittyvistä muutoksista ja päivityksistä. Tämä sivu sisältää tietoa API:n käyttämiseen liittyvistä rajoituksista ja vastuista, joten suosittelemme sen huolellista lukemista.
Dokumentaatio
Päivittyvät muuttujat on merkitty dokumentoinnissa hakasulkeilla. Esimerkiksi {ACCESS_TOKEN} vastaa ylläpidosta löytyvää asiakastunnusta ja {SHARED_SECRET} yhteistä tunnistetta. Valinnaiset parametrit näytetään erotettuna toisistaan pystyviivalla esimerkiksi: {xml|json|php}.
Apin rakenne
Creamailer pidättää kaikki oikeudet muokata API:n rakennetta, käyttöoikeuksia ja käyttöehtoja ilman ennakkovaroitusta. Toimintoja saatetaan esimerkiksi poistaa väliaikaisesti käytöstä, jos ne vaikuttavat tuleviin ominaisuuksiin. Mahdollisista muutoksista pyritään tiedottamaan API:n postituslistalla ja ylläpidosta löytyvissä tiedotteissa. Rakenne pyritään pitämään jokaisessa API:n versiossa ennallaan ja isommat rakenteelliset muutokset pyritään tekemään API:n uuteen versioon, johon päivitetään tulevaisuudessa helposti vaihtamalla osoitteesta löytyvä versionumero (tämän hetkinen versio: v1).
Käytön rajoitukset
Creamailer sallii sadan API-kutsun tekemisen tunnin aikana. Kun määrä tulee täyteen palautetaan virheilmoitus 400 sekä Retry-After-header, jossa on määritelty kokonaislukuna monenko sekunnin jälkeen kutsuja aletaan ottamaan vastaan. Jotta kaikki sujuisi mahdollisimman jouhevasti, tämä kannattaa ottaa huomioon integroinnin toteutuksessa.
Tietoturva
API:n käyttäminen onnistuu ainoastaan salatun HTTPS-yhteyden kautta. Lisäksi jokaisen kutsun yhteydessä lähetetään Yhteisen tunnisteen avulla laskettu tarkistussumma. Tämä takaa erittäin hyvän tietoturvan eikä kolmas taho pysty muokkaamaan API-kutsua tämän jälkeen. API:iin liittyviä asiakastunnuksia voidaan lisätä rajattomasti Creamailerin ylläpidosta ja niille voidaan määritellä luku ja/tai kirjoitusoikeus. Tunnukset voidaan myös poistaa suoraan ylläpidosta näin haluttaessa.
Ongelmatilanteet
Creamailer API pyrkii aina ongelman sattuessa vastaamaan sitä kuvaavalla virheilmoituksella. Virheilmoitus on hyvä olla tiedossa oltaessa tukeen yhteydessä.
Kommentit
0 kommenttia
Kirjaudu sisään jättääksesi kommentin.