cm-service v1.0.0

Skjalakerfi vefþjónusta

Þessi vefþjónusta sér um að lesa upp úr og skrá í skjalakerfið. Til að sjá kóðadæmi er hægt að skoða test/api.js

Það á eftir að búa til alvöru client með TS sem skilar réttum objectum. Þangað til er hægt að tala beint við.

Getting Started

Requirements

• Node.js 10.x.x
• Java >= 11

$ brew install nvm
$ nvm use # This uses .nvmrc as the version
$ brew cask install caskroom/versions/java11

Running

1. Find and set these environment variables

• AS400_HOST
• AS400_USERNAME
• AS400_PASSWORD
• DOKOBIT_ACCESS_TOKEN

2. Connect to VPN
3. Run

npm run dev

This will run the server and restart it on file changes

API

GraphQL

Í gegnum graphql er hægt að undirrita rafrænt undir skjöl sem eru með eSignature='Pending'.

Sjá nánar hér: docs

Skjöl

/api/v1/file/ (post)

Tekur á móti multpart form-post með attachmenti. Þjónustan vistar skjalið og skrifar í grunninn. Hægt að senda með lýsingu og annað nafn. Þarf að senda týpu skjals með.

Dæmi með superagent:

const request = require('superagent')
request
    .post('http://cm-service.dev.it.tm.is/api/v1/file')
    .withCredentials() // Þurfum kökuna til að authenticata
    .type('form')
    .attach('cm', __dirname + '/../../../test_data/penguin.jpg') // Required
    .field('type', 'TjonLogregluskBill') // Required
    .field('name', 'mynd.jpg') // Optional
    .field('description', 'mynd af mörgæsum') // Optional
    .field('eSignature', 'Pending') // Optional, can be: 'Pending' | 'Signed'
    .end(function(err, res) {
        if (error) {
            // Einhver server villa eða crash
        }

        console.log('Vistaði mynd sem fékk ID: ' + res.fileId)
    })

/api/v1/file/:id (get)

Sækir upplýsingar úr skjalatöflu fyrir ákveðið skjal og birtir sem JSON object.

Dæmi með superagent:

const request = require('superagent')
request
    .get('http://cm-service.dev.it.tm.is/api/v1/file/2115')
    .withCredentials() // Þurfum authenticate
    .then(res => {
        console.log(res)
    })

/api/v1/file/src/:id (get)

Þjónustan streymir skjalinu (gögnum) beint út sem. Strauminn er hægt að pípa áfram eða taka saman.

Dæmi með superagent:

const request = require('superagent')

const req = request
    .get('http://cm-service.dev.it.tm.is/api/v1/file/2115')
    .withCredentials() // Þurfum authenticate

req.pipe(einhverstraumur)

/api/v1/file/search

Leitar eftir skrám útfrá querystring. Tekur á móti id, actionnr, type (strId) eða lyklum og skilar lista af niðursötðum.

const request = require('superagent')

request
    .get('http://cm-service.dev.it.tm.is/api/v1/file/search')
    .withCredentials() // Þurfum authenticate
    .query({
        id: '2115',
        type: 'TjonLogregluskBill',
        actionnr: '',
        keys: 'Tjonsnr,KT',
    })
    .then(res => {
        console.log(res)
    })

Skjalategundir

/api/v1/filetype (get)

Skilar lista af öllum skjalategundum

const request = require('superagent')

request
    .get('/api/v1/filetype')
    .withCredentials() // Þurfum authenticate
    .then(res => {
        console.log(res)
    })

Lyklar

/api/v1/key (get)

Skilar lista af öllum skjalalyklum

const request = require('superagent')

request
    .get('/api/v1/key')
    .withCredentials() // Þurfum authenticate
    .then(res => {
        console.log(res)
    })