Velosimo | Integration Platform for eGovernment

Retrieve all existing Flows you have previously created.

get https://connect.velosimo.io/api/v2/setup/flow.json

tenant_access_key='...'
tenant_access_token='...'

curl -X GET \
     -H "X-Tenant-Access-Key: ${tenant_access_key}" \
     -H "X-Tenant-Access-Token: ${tenant_access_token}" \
     -H "Content-Type: application/json" \
     -d '{"page":1,"limit":25,"order":"id"}' \
     "https://connect.velosimo.io/api/v2/setup/flow.json"

$tenant_access_key = '...';
$tenant_access_token = '...';
$uri = "https://connect.velosimo.io/api/v2/setup/flow.json";
$headers = array(
  "Content-Type: application/json",
  "X-Tenant-Access-Key: ${tenant_access_key}",
  "X-Tenant-Access-Token: ${tenant_access_token}"
);
$options = array(
  'http' => array(
    'header'  => implode($headers, "\r\n"),
    'method'  => 'GET',
    'content' => '{"page":1,"limit":25,"order":"id"}'
  )
);

$context  = stream_context_create($options);
$response = file_get_contents($uri, false, $context);

print_r(json_decode($response, true));

require 'rest-client'
require 'json'

tenant_access_key = '...'
tenant_access_token = '...'

response = RestClient::Request.execute(
  :url => "https://connect.velosimo.io/api/v2/setup/flow.json",
  :method => 'GET',
  :payload => '{"page":1,"limit":25,"order":"id"}',
  :headers => {
    'Content-Type' => 'application/json',
    'X-Tenant-Access-Key' => tenant_access_key,
    'X-Tenant-Access-Token' => tenant_access_token
  }
)

puts JSON.parse(response.body)

import json
from requests import Request, Session

tenant_access_key = '...'
tenant_access_token = '...'
uri = 'https://connect.velosimo.io/api/v2/setup/flow.json' % (tenant_access_key, tenant_access_token)
options = {
  'headers': {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  'data': json.dumps({"page":1,"limit":25,"order":"id"})
};

session = Session()
request = Request('GET', uri, **options)
prepped = request.prepare()
response = session.send(prepped)

print(response.json())

var request = require('request'),
    tenant_access_key = '...',
    tenant_access_token = '...',
    options = {
      method: 'GET',
      url: 'https://connect.velosimo.io/api/v2/setup/flow.json',
      headers: {
        'Content-Type': 'application/json',
        'X-Tenant-Access-Key': tenant_access_key,
        'X-Tenant-Access-Token': tenant_access_token
      },
      json: true,
      qs: {"page":1,"limit":25,"order":"id"}
    };

request(options, function (error, response, data) {
  if (error) throw error;

  console.log(data);
});

var tenant_access_key = '...',
    tenant_access_token = '...';

jQuery.ajax({
  url: 'https://connect.velosimo.io/api/v2/setup/flow.json',
  method: 'GET',
  dataType: 'json',
  crossOrigin: true,
  headers: {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  data: {"page":1,"limit":25,"order":"id"},
  success: function(data, textStatus, jqXHR) {
    console.log(data);
  }
});

Creates the specified Flow. Any parameters not provided will be left unchanged.

post https://connect.velosimo.io/api/v2/setup/flow.json

tenant_access_key='...'
tenant_access_token='...'

curl -X POST \
     -H "X-Tenant-Access-Key: ${tenant_access_key}" \
     -H "X-Tenant-Access-Token: ${tenant_access_token}" \
     -H "Content-Type: application/json" \
     -d '{"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}' \
     "https://connect.velosimo.io/api/v2/setup/flow.json"

$tenant_access_key = '...';
$tenant_access_token = '...';
$uri = "https://connect.velosimo.io/api/v2/setup/flow.json";
$headers = array(
  "Content-Type: application/json",
  "X-Tenant-Access-Key: ${tenant_access_key}",
  "X-Tenant-Access-Token: ${tenant_access_token}"
);
$options = array(
  'http' => array(
    'header'  => implode($headers, "\r\n"),
    'method'  => 'POST',
    'content' => '{"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}'
  )
);

$context  = stream_context_create($options);
$response = file_get_contents($uri, false, $context);

print_r(json_decode($response, true));

require 'rest-client'
require 'json'

tenant_access_key = '...'
tenant_access_token = '...'

response = RestClient::Request.execute(
  :url => "https://connect.velosimo.io/api/v2/setup/flow.json",
  :method => 'POST',
  :payload => '{"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}',
  :headers => {
    'Content-Type' => 'application/json',
    'X-Tenant-Access-Key' => tenant_access_key,
    'X-Tenant-Access-Token' => tenant_access_token
  }
)

puts JSON.parse(response.body)

import json
from requests import Request, Session

tenant_access_key = '...'
tenant_access_token = '...'
uri = 'https://connect.velosimo.io/api/v2/setup/flow.json' % (tenant_access_key, tenant_access_token)
options = {
  'headers': {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  'data': json.dumps({"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}})
};

session = Session()
request = Request('POST', uri, **options)
prepped = request.prepare()
response = session.send(prepped)

print(response.json())

var request = require('request'),
    tenant_access_key = '...',
    tenant_access_token = '...',
    options = {
      method: 'POST',
      url: 'https://connect.velosimo.io/api/v2/setup/flow.json',
      headers: {
        'Content-Type': 'application/json',
        'X-Tenant-Access-Key': tenant_access_key,
        'X-Tenant-Access-Token': tenant_access_token
      },
      json: true,
      body: {"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}
    };

request(options, function (error, response, data) {
  if (error) throw error;

  console.log(data);
});

var tenant_access_key = '...',
    tenant_access_token = '...';

jQuery.ajax({
  url: 'https://connect.velosimo.io/api/v2/setup/flow.json',
  method: 'POST',
  dataType: 'json',
  crossOrigin: true,
  headers: {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  data: JSON.stringify({"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}),
  success: function(data, textStatus, jqXHR) {
    console.log(data);
  }
});

Retrieves the details of an existing Flow. You need only supply the unique Flow identifier that was returned upon Flow creation.

get https://connect.velosimo.io/api/v2/setup/flow/{id}.json

tenant_access_key='...'
tenant_access_token='...'
id='...'

curl -X GET \
     -H "X-Tenant-Access-Key: ${tenant_access_key}" \
     -H "X-Tenant-Access-Token: ${tenant_access_token}" \
     -H "Content-Type: application/json" \
     "https://connect.velosimo.io/api/v2/setup/flow/${id}.json"

$tenant_access_key = '...';
$tenant_access_token = '...';
$id = '...';
$uri = "https://connect.velosimo.io/api/v2/setup/flow/${id}.json";
$headers = array(
  "Content-Type: application/json",
  "X-Tenant-Access-Key: ${tenant_access_key}",
  "X-Tenant-Access-Token: ${tenant_access_token}"
);
$options = array(
  'http' => array(
    'header'  => implode($headers, "\r\n"),
    'method'  => 'GET',
  )
);

$context  = stream_context_create($options);
$response = file_get_contents($uri, false, $context);

print_r(json_decode($response, true));

require 'rest-client'
require 'json'

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'

response = RestClient::Request.execute(
  :url => "https://connect.velosimo.io/api/v2/setup/flow/#{id}.json",
  :method => 'GET',
  :headers => {
    'Content-Type' => 'application/json',
    'X-Tenant-Access-Key' => tenant_access_key,
    'X-Tenant-Access-Token' => tenant_access_token
  }
)

puts JSON.parse(response.body)

from requests import Request, Session

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'
uri = 'https://connect.velosimo.io/api/v2/setup/flow/%s.json' % (tenant_access_key, tenant_access_token, id)
options = {
  'headers': {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
};

session = Session()
request = Request('GET', uri, **options)
prepped = request.prepare()
response = session.send(prepped)

print(response.json())

var request = require('request'),
    tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...',
    options = {
      method: 'GET',
      url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}.json',
      headers: {
        'Content-Type': 'application/json',
        'X-Tenant-Access-Key': tenant_access_key,
        'X-Tenant-Access-Token': tenant_access_token
      },
      json: true,
    };

request(options, function (error, response, data) {
  if (error) throw error;

  console.log(data);
});

var tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...';

jQuery.ajax({
  url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}.json',
  method: 'GET',
  dataType: 'json',
  crossOrigin: true,
  headers: {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  success: function(data, textStatus, jqXHR) {
    console.log(data);
  }
});

Updates the specified Flow. Any parameters not provided will be left unchanged.

post https://connect.velosimo.io/api/v2/setup/flow/{id}.json

tenant_access_key='...'
tenant_access_token='...'
id='...'

curl -X POST \
     -H "X-Tenant-Access-Key: ${tenant_access_key}" \
     -H "X-Tenant-Access-Token: ${tenant_access_token}" \
     -H "Content-Type: application/json" \
     -d '{"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}' \
     "https://connect.velosimo.io/api/v2/setup/flow/${id}.json"

$tenant_access_key = '...';
$tenant_access_token = '...';
$id = '...';
$uri = "https://connect.velosimo.io/api/v2/setup/flow/${id}.json";
$headers = array(
  "Content-Type: application/json",
  "X-Tenant-Access-Key: ${tenant_access_key}",
  "X-Tenant-Access-Token: ${tenant_access_token}"
);
$options = array(
  'http' => array(
    'header'  => implode($headers, "\r\n"),
    'method'  => 'POST',
    'content' => '{"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}'
  )
);

$context  = stream_context_create($options);
$response = file_get_contents($uri, false, $context);

print_r(json_decode($response, true));

require 'rest-client'
require 'json'

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'

response = RestClient::Request.execute(
  :url => "https://connect.velosimo.io/api/v2/setup/flow/#{id}.json",
  :method => 'POST',
  :payload => '{"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}',
  :headers => {
    'Content-Type' => 'application/json',
    'X-Tenant-Access-Key' => tenant_access_key,
    'X-Tenant-Access-Token' => tenant_access_token
  }
)

puts JSON.parse(response.body)

import json
from requests import Request, Session

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'
uri = 'https://connect.velosimo.io/api/v2/setup/flow/%s.json' % (tenant_access_key, tenant_access_token, id)
options = {
  'headers': {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  'data': json.dumps({"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}})
};

session = Session()
request = Request('POST', uri, **options)
prepped = request.prepare()
response = session.send(prepped)

print(response.json())

var request = require('request'),
    tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...',
    options = {
      method: 'POST',
      url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}.json',
      headers: {
        'Content-Type': 'application/json',
        'X-Tenant-Access-Key': tenant_access_key,
        'X-Tenant-Access-Token': tenant_access_token
      },
      json: true,
      body: {"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}
    };

request(options, function (error, response, data) {
  if (error) throw error;

  console.log(data);
});

var tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...';

jQuery.ajax({
  url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}.json',
  method: 'POST',
  dataType: 'json',
  crossOrigin: true,
  headers: {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  data: JSON.stringify({"creator_id":{},"updater_id":{},"tenant_id":{},"namespace":"","name":"","description":"","event_id":{},"translator_id":{},"custom_data_type_id":{},"data_type_scope":"","scope_filter":"","scope_evaluator_id":{},"lot_size":0,"webhook_id":{},"authorization_id":{},"connection_role_id":{},"before_submit_id":{},"response_translator_id":{},"response_data_type_id":{}}),
  success: function(data, textStatus, jqXHR) {
    console.log(data);
  }
});

Permanently deletes an existing Flow. It cannot be undone.

delete https://connect.velosimo.io/api/v2/setup/flow/{id}.json

tenant_access_key='...'
tenant_access_token='...'
id='...'

curl -X DELETE \
     -H "X-Tenant-Access-Key: ${tenant_access_key}" \
     -H "X-Tenant-Access-Token: ${tenant_access_token}" \
     -H "Content-Type: application/json" \
     "https://connect.velosimo.io/api/v2/setup/flow/${id}.json"

$tenant_access_key = '...';
$tenant_access_token = '...';
$id = '...';
$uri = "https://connect.velosimo.io/api/v2/setup/flow/${id}.json";
$headers = array(
  "Content-Type: application/json",
  "X-Tenant-Access-Key: ${tenant_access_key}",
  "X-Tenant-Access-Token: ${tenant_access_token}"
);
$options = array(
  'http' => array(
    'header'  => implode($headers, "\r\n"),
    'method'  => 'DELETE',
  )
);

$context  = stream_context_create($options);
$response = file_get_contents($uri, false, $context);

print_r(json_decode($response, true));

require 'rest-client'
require 'json'

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'

response = RestClient::Request.execute(
  :url => "https://connect.velosimo.io/api/v2/setup/flow/#{id}.json",
  :method => 'DELETE',
  :headers => {
    'Content-Type' => 'application/json',
    'X-Tenant-Access-Key' => tenant_access_key,
    'X-Tenant-Access-Token' => tenant_access_token
  }
)

puts JSON.parse(response.body)

from requests import Request, Session

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'
uri = 'https://connect.velosimo.io/api/v2/setup/flow/%s.json' % (tenant_access_key, tenant_access_token, id)
options = {
  'headers': {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
};

session = Session()
request = Request('DELETE', uri, **options)
prepped = request.prepare()
response = session.send(prepped)

print(response.json())

var request = require('request'),
    tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...',
    options = {
      method: 'DELETE',
      url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}.json',
      headers: {
        'Content-Type': 'application/json',
        'X-Tenant-Access-Key': tenant_access_key,
        'X-Tenant-Access-Token': tenant_access_token
      },
      json: true,
    };

request(options, function (error, response, data) {
  if (error) throw error;

  console.log(data);
});

var tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...';

jQuery.ajax({
  url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}.json',
  method: 'DELETE',
  dataType: 'json',
  crossOrigin: true,
  headers: {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  success: function(data, textStatus, jqXHR) {
    console.log(data);
  }
});

Retrieves one attribute of an existing Flow.

get https://connect.velosimo.io/api/v2/setup/flow/{id}/{view}.json

tenant_access_key='...'
tenant_access_token='...'
id='...'
view='...'

curl -X GET \
     -H "X-Tenant-Access-Key: ${tenant_access_key}" \
     -H "X-Tenant-Access-Token: ${tenant_access_token}" \
     -H "Content-Type: application/json" \
     "https://connect.velosimo.io/api/v2/setup/flow/${id}/${view}.json"

$tenant_access_key = '...';
$tenant_access_token = '...';
$id = '...';
$view = '...';
$uri = "https://connect.velosimo.io/api/v2/setup/flow/${id}/${view}.json";
$headers = array(
  "Content-Type: application/json",
  "X-Tenant-Access-Key: ${tenant_access_key}",
  "X-Tenant-Access-Token: ${tenant_access_token}"
);
$options = array(
  'http' => array(
    'header'  => implode($headers, "\r\n"),
    'method'  => 'GET',
  )
);

$context  = stream_context_create($options);
$response = file_get_contents($uri, false, $context);

print_r(json_decode($response, true));

require 'rest-client'
require 'json'

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'
view = '...'

response = RestClient::Request.execute(
  :url => "https://connect.velosimo.io/api/v2/setup/flow/#{id}/#{view}.json",
  :method => 'GET',
  :headers => {
    'Content-Type' => 'application/json',
    'X-Tenant-Access-Key' => tenant_access_key,
    'X-Tenant-Access-Token' => tenant_access_token
  }
)

puts JSON.parse(response.body)

from requests import Request, Session

tenant_access_key = '...'
tenant_access_token = '...'
id = '...'
view = '...'
uri = 'https://connect.velosimo.io/api/v2/setup/flow/%s/%s.json' % (tenant_access_key, tenant_access_token, id, view)
options = {
  'headers': {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
};

session = Session()
request = Request('GET', uri, **options)
prepped = request.prepare()
response = session.send(prepped)

print(response.json())

var request = require('request'),
    tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...',
    view = '...',
    options = {
      method: 'GET',
      url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}/${view}.json',
      headers: {
        'Content-Type': 'application/json',
        'X-Tenant-Access-Key': tenant_access_key,
        'X-Tenant-Access-Token': tenant_access_token
      },
      json: true,
    };

request(options, function (error, response, data) {
  if (error) throw error;

  console.log(data);
});

var tenant_access_key = '...',
    tenant_access_token = '...',
    id = '...',
    view = '...';

jQuery.ajax({
  url: 'https://connect.velosimo.io/api/v2/setup/flow/${id}/${view}.json',
  method: 'GET',
  dataType: 'json',
  crossOrigin: true,
  headers: {
    'Content-Type': 'application/json',
    'X-Tenant-Access-Key': tenant_access_key,
    'X-Tenant-Access-Token': tenant_access_token
  },
  success: function(data, textStatus, jqXHR) {
    console.log(data);
  }
});

Contact us