Wiki source code of Community App Developer Guide

Version 19.1 by allan on 2020/01/23 15:47
Show last authors
1 Developers can extend the Collaboratory capabilities by providing applications to its community of users.
2
3 This guide describes the steps to make this possible.
4
5 == Becoming a contributor ==
6
7 The first step is for you to **get the developer accreditation**. Contributors can register and manage applications within the Community Apps Catalogue.
8
9 Send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions.
10
11 The support team will apply the permissions to your user: your account will be [[upgraded with developers privileges>>doc:Collabs.collab-devs.User administration.WebHome]] the next time you will login.
12
13 (% class="box infomessage" %)
14 (((
15 Only SGA2 accredited users will be automatically granted the developer accreditation.
16 )))
17
18 == Making your app available to users ==
19
20 In order for you application to be installable by users, it needs to be registered within the [[Community Apps Catalogue>>doc:Apps.WebHome]].
21
22 Once this simple step is complete, users will be able to install your app within their collabs.
23
24 === Registering an application in the Catalogue ===
25
26 Navigate to the catalogue and click on **+Create App** in the top right corner. Enter a name for your app and click on **Create**.
27
28 Fill the form with the following information:
29
30 * **main URL**: the URL of the homepage of your app. This is where user will be directed when then open your app in a collab.
31 * **settings URL**: the URL of the your settings management page if you have one.
32 * **description**: a description of what your app does to help users select it.
33 * **under development?**: should be checked if you don't want your app to be available by default by other users.
34 * **category**: a category to help structuring the applications.
35 * **maintainers**: a list of users who maintain the app. The users need to have logged in the wiki at least once to be found. Maintainers are granted the right to modify an app registration.
36 * **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app.
37 * **repository**: a URL to a public repository so users can check the sources of your app.
38
39 Click on **Save**. Your app is now registered and waiting for users to install it!
40
41 === Installing your app in a collab ===
42
43 1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **administrator** role.
44 1. Click on **Create**. Enter a title for this instance of your app and select **Community App** in the right selector.
45 1. Click on **Create**. You will be presented with the Community App Catalogue. The app you will see are the public apps and the ones your a maintainer of.
46 1. Select your app and click on **Save and View**.
47
48 You should now see how your app looks like within a collab.
49
50 == Getting your app instance context ==
51
52 Instances of your applications will be installed by collab authors in many different collabs. In order to let you customise the user experience based on its context, the Collaboratory will automatically pass query parameters to your app:
53
54 * **##clb-collab-id##**: the unique, human-readable identifier of the collab.
55 * ##**clb-doc-path**##: the path of your app instance within the collab. If your app is at the root of a collab, this value will be empty.
56 * ##**clb-doc-name**##: the name of the document where your app instance is installed.
57 * ##**clb-drive-id**##: the unique identifier of the drive of the collab. This id is required if you want to fetch or store documents within the drive of the collab.
58
59 == App settings ==
60
61 The app settings are the values the collab author can modify to change the behaviour of your application within her collab.
62
63 === Writing settings ===
64
65 The Collaboratory comes with a mechanism to let your app store these settings directly in the Collaboratory.
66
67 In order to do that, your app needs to use the [[postMessage javascript API>>https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage]] to send the settings to store to the Collaboratory:
68
69 {{code language="javascript"}}
70 window.parent.postMessage({
71 topic: '/clb/community-app/settings',
72 data: {
73 setting1: 'setting 1 value',
74 setting2: 'setting 2 value',
75 // ...
76 // reload: false // avoid page reload on settings change
77 }}, 'https://wiki.humanbrainproject.eu');
78 {{/code}}
79
80 === Fetching settings ===
81
82 The Collaboratory will get the settings from its key/value store and pass them to your app through query parameters.
83
84 == Creating your OpenID Connect client ==
85
86 The steps to create an OpenID Connect client are the following:
87
88 1. get an access token from the `developer` client
89 1. use the token to call the create endpoint
90 1. save your registration access token for further modifications of your client
91
92 === Fetching your developer access token ===
93
94 Getting your developer token is done in one simple step: authenticate against the developer client with the password grant.
95
96 This can be achieved with this sample shell script:
97
98 {{code language="bash"}}
99 # Gather username and password from user
100 echo '\nEnter your username' && read clb_dev_username &&
101 echo '\nEnter your password' && read -s clb_dev_pwd &&
102
103 # Fetch the token
104 curl -X POST https://iam.humanbrainproject.eu/auth/realms/hbp/protocol/openid-connect/token \
105 -u developer: \
106 -d 'grant_type=password' \
107 --data-urlencode "username=${clb_dev_username}" \
108 --data-urlencode "password=${clb_dev_pwd}" |
109
110 # Prettify the JSON response
111 json_pp;
112
113 # Erase the credentials from local variables
114 clb_dev_pwd='';clb_dev_username=''
115 {{/code}}
116
117 The response will be similar to:
118
119 {{code language="json"}}
120 {
121 "access_token": "eyJhbGci...",
122 "expires_in": 108000,
123 "refresh_expires_in": 14400,
124 "refresh_token": "eyJhbGci...",
125 "token_type": "bearer",
126 "not-before-policy": 1563261088,
127 "session_state": "0ac3dfcd-aa5e-42eb-b333-2f73496b81f8",
128 "scope": ""
129 }
130 {{/code}}
131
132 Copy the "access_token" value, you will need if for the next step.
133
134 === Creating the client ===
135
136 You can now create clients by sending a JSON representation to a specific endpoint:
137
138 {{code language="bash"}}
139 # Set your developer token
140 clb_dev_token=...
141
142 # Send the creation request
143 curl -X POST https://iam.humanbrainproject.eu/auth/realms/hbp/clients-registrations/default/ \
144 -H "Authorization: Bearer ${clb_dev_token}" \
145 -H 'Content-Type: application/json' \
146 -d '{
147 "clientId": "my-awesome-client",
148 "name": "My Awesome App",
149 "description": "This describes what my app is for end users",
150 "rootUrl": "https://root.url.of.my.app",
151 "baseUrl": "/relative/path/to/its/frontpage.html",
152 "redirectUris": [
153 "/relative/redirect/path",
154 "/these/can/use/wildcards/*"
155 ],
156 "webOrigins": ["+"],
157 "bearerOnly": false,
158 "consentRequired": true,
159 "standardFlowEnabled": true,
160 "implicitFlowEnabled": true,
161 "directAccessGrantsEnabled": false,
162 "attributes": {
163 "contacts": "first.contact@example.com; second.contact@example.com"
164 }
165 }' |
166
167 # Prettify the JSON response
168 json_pp;
169 {{/code}}
170
171 In case of success, the endpoint will return its representation of your client:
172
173 {{code language="json"}}
174 {
175 "defaultClientScopes" : [
176 "web-origins",
177 "roles"
178 ],
179 "redirectUris" : [
180 "/relative/redirect/path",
181 "/these/can/use/wildcards/*"
182 ],
183 "nodeReRegistrationTimeout" : -1,
184 "rootUrl" : "https://root.url.of.my.app",
185 "webOrigins" : [
186 "+"
187 ],
188 "authenticationFlowBindingOverrides" : {},
189 "baseUrl" : "/relative/path/to/its/frontpage.html",
190 "description" : "This describes what my app is for end users",
191 "notBefore" : 0,
192 "frontchannelLogout" : false,
193 "enabled" : true,
194 "registrationAccessToken" : "eyJhbGciOi...",
195 "consentRequired" : true,
196 "fullScopeAllowed" : false,
197 "clientAuthenticatorType" : "client-secret",
198 "surrogateAuthRequired" : false,
199 "directAccessGrantsEnabled" : false,
200 "standardFlowEnabled" : true,
201 "id" : "551b49a0-ec69-41af-9461-6c10fbc79a35",
202 "attributes" : {
203 "contacts" : "first.contact@example.com; second.contact@example.com"
204 },
205 "name" : "My Awesome App",
206 "secret" : "your-client-secret",
207 "publicClient" : false,
208 "clientId" : "my-awesome-client",
209 "optionalClientScopes" : [],
210 "implicitFlowEnabled" : true,
211 "protocol" : "openid-connect",
212 "bearerOnly" : false,
213 "serviceAccountsEnabled" : false
214 }
215 {{/code}}
216
217 Among all the attributes, you should securely save:
218
219 * your client **secret** ("secret" attribute): it is needed by your application to **authenticate to the IAM server** when making backend calls
220 * your client **registration access token** ("registrationAccessToken"): you will need it to authenticate when **modifying your client in the future**
221
222 === Modifying your client ===
223
224 Update your client with a PUT request:
225
226 {{code language="bash"}}
227 # Set your registration token and client id
228 clb_reg_token=...
229
230 # Update the client
231 curl -X PUT https://iam.humanbrainproject.eu/auth/realms/hbp/clients-registrations/default/my-awesome-client \
232 -H "Authorization: Bearer ${clb_reg_token}" \
233 -H 'Content-Type: application/json' \
234 -d '{
235 "clientId": "my-awesome-client",
236 "redirectUris": [
237 "/relative/redirect/path",
238 "/these/can/use/wildcards/*",
239 "/a/new/redirect/uri"
240 ]
241 }' |
242
243 # Prettify the JSON response
244 json_pp;
245 {{/code}}
246
247 Note that your need to provide your client id both in the endpoint URL and within the body of the request.
248
249 {{warning}}
250 /!\ ** Each time you modify your client, a new registration access token will be generated. You need to track of your token changes to keep access to your client.   **/!\
251 {{/warning}}