documentation/apiary.apib at master · linked2/documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
FORMAT: 1A
HOST: http://polls.apiblueprint.org/

# Linked2

Polls is a simple API allowing consumers to view polls and vote in them.

## Questions Collection [/questions]

### List All Questions [GET]

+ Response 200 (application/json)

        [
            {
                "question": "Favourite programming language?",
                "published_at": "2015-08-05T08:40:51.620Z",
                "choices": [
                    {
                        "choice": "Swift",
                        "votes": 2048
                    }, {
                        "choice": "Python",
                        "votes": 1024
                    }, {
                        "choice": "Objective-C",
                        "votes": 512
                    }, {
                        "choice": "Ruby",
                        "votes": 256
                    }
                ]
            }
        ]

### Create a New Question [POST]

You may create your own question using this action. It takes a JSON
object containing a question and a collection of answers in the
form of choices.

+ Request (application/json)

        {
            "question": "Favourite programming language?",
            "choices": [
                "Swift",
                "Python",
                "Objective-C",
                "Ruby"
            ]
        }

+ Response 201 (application/json)

    + Headers

            Location: /questions/2

    + Body

            {
                "question": "Favourite programming language?",
                "published_at": "2015-08-05T08:40:51.620Z",
                "choices": [
                    {
                        "choice": "Swift",
                        "votes": 0
                    }, {
                        "choice": "Python",
                        "votes": 0
                    }, {
                        "choice": "Objective-C",
                        "votes": 0
                    }, {
                        "choice": "Ruby",
                        "votes": 0
                    }
                ]
            }

            # DRAFT DOCUMENTATION

Status: Unpublished

Author: Rob Smith

Version: 1.0

Date: 28th Dec 2018

# Linked2 iPaaS

Increasingly we don't use software applications in isolation, but rather as one tenant of a software platform. We use software as part of a cloud and we gain benefits from that.

The Linked2 platform integrates at a platform to platform level, providing an integration product specifically tailored for moving data between two specific platforms. Together with our white label approach this enables our integration products to appear to be part of the platforms they are integrating.

## Pipeline
Purely a descriptive term for a configured & live integration from source system to target system. In that sense the integration 'pipeline' includes code to send the data, the protocol its sent over, the receivers (webhook/api) that data for Linked2, the whole Linked2 process including publishing and the protocol used and finally the receiving api in the target system.

## Products

A Linked2 product is just like any other software product, it is basically just an uninstalled, unconfigured package that needs to be installed with specific configurations to be useful. You will have at least one Linked2 integration product.

## Stages

A stage is our term for an installed product. A stage is a live integration pipeline between two systems. Data only flows one way through a stage. At the time of writing we have only products with single stages, so to create a bi-directional integration would require installing two products. A future release will enable multiple stages in a single product making the installation process for more than single data flows much simpler.

## Filters

## Transformers

## Publishers & the Publish Context

## Support

## Webhooks and Batches