Ohjelmointirajapinta (API)

Ohjelmointirajapinta (API) kattaa perustoiminnallisuudet ja mahdollistaa Passworkin liittämisen infrastruktuuriisi tai oman client-sovelluksen kehittämisen.

Yleistä
  1. Ohjelmointirajapintaa käytetään HTTP POST-pyyntöjen avulla
  2. Ohjelmointirajapinnan osoite — https://passwork.me/api2/
  3. Ohjelmointirajapinta käyttää JSON-formaattia
  4. Suosittelemme vahvasti HTTPS-yhteyden käyttämistä
Libs
  1. Javascript API Connector
  2. .Net API Connector
Palvelimen vastaus

{
    'response' : { ... },
    'errorCode' : '...',
    'errorMessage' : '...'
}
                    

Virhetilanteessa response on epätosi (false).

Kaikki seuraavat esimerkit liittyvät response kenttään.

Avaa istunto

/api2/openSession

Avaa uuden istunnon. Palauttaa istuntokoodin, joka välitetään jokaisessa pyynnössä. Istunto päättyy automaattisesti joidenkin minuuttien kuluttua.

Parametrit:

email
Käyttäjän sähköpostiosoite (login)

password
Pääsynhallinnan salasana

Palvelimen vastaus:

Success

{
    'code' : '...', // istuntokoodi
    'hash' : '...'  // Master-salasanan md5-tiiviste
}
                    

Kenttä сode on sisällytettävä jokaiseen seuraavaan ohjelmointirajapinnalle lähetettävään pyyntöön.
Kenttää hash käytetään Master-salasanan oikeellisuutta tarkistettaessa.


Virheet:

response = false

Käyttäjän sähköpostiosoite (login) tai pääsynhallinnan salasana väärin.

errorCode = ban

Toistuneista epäonnistuneista yrityksistä johtuen, käyttäjän ei sallita avata uutta istuntoa.

Nouda tiedot

/api2/getData

Nouda kaikki salasanat

Parametrit:

session
Istuntokoodi

Palvelimen vastaus:

Data

{
    'user' : '...', // käyttäjän tunniste
    'groups' : [{  // jono holveja
        'id' : '...', // holvin tunniste
        'name' : '...', // holvin nimi
        'passwordCrypted' : '...',  // salattu holvin kutsukoodi
        'folders' :[{  // jono kansioita
            'id' : '...',  // kansion tunniste
            'name' : '...', // kansion nimi
            'passwords' : [{ // jono salasanoja
                'id' : '...', // salasanan tunniste
                'categoryId' : '...', // kategorian tunniste
                'groupId' : '...', // holvin tunniste
                'name' : '...', // salasanan nimi
                'login' : '...',
                'url', : '...',
                'description' : '...',
                'cryptedPassword' : '...', // salattu salasana
                }]
            }]
        }],
        'passwords' : [{ // jono salasanoja
            'id' : '...', // salasanan tunniste
            'categoryId' : '...', // kategorian tunniste
            'groupId' : '...', // holvin tunniste
            'name' : '...', // salasanan nimi
            'login' : '...',
            'url', : '...',
            'description' : '...',
            'cryptedPassword' : '...', // salattu salasana
            }]
        }]
}
                    

Virheet:

{
    'response' : false,
    'errorCode' : 'expired',
    'errorMessage' : 'Session expired'
}
                    

Istunto on päättynyt. Uusi istunto tulee avata openSession pyynnön avulla.

Päivitä ja lisää

Nämä ohjelmointirajapintafunktiot ovat testivaiheessa ja julkaistaan lähitulevaisuudessa.

Esimerkki

  1. Avaa uusi sessio openSession avulla
  2. Lataa kaikki tiedot getData avulla
  3. Kysy käyttäjän master-salasana
  4. Pura holvin kutsukoodin salaus (käyttäen master-salasanaa) groups[X].passwordCrypted
  5. Pura tietojen salaus (käyttäen holvin kutsukoodia) groups[X].folders[Y].passwords[Z].cryptedPassword