Technische documentatie voor integrators - Revision history

Thomas.sonck at 16:04, 22 March 2023

2023-03-22T16:04:58Z

← Older revision		Revision as of 16:04, 22 March 2023
Line 433:		Line 433:
	class SessionRequestCreateObject {		class SessionRequestCreateObject {
	"code": string, // request via /api/v1/sessionrequests/generate-codes/<amount>		"code": string, // request via /api/v1/sessionrequests/generate-codes/<amount>
	"url": string, // example <mijn-~~kantoor~~>.sidefish.be/nl/#/<vragenlijst-identifier>/<session-code>		"url": string, // example <mijn-bedrijf>.sidefish.be/nl/#/<vragenlijst-identifier>/<session-code>
	"type": "qlist",		"type": "qlist",
	"customer": string, // _id of the customer		"customer": string, // _id of the customer
	"~~questionList~~": string, // _id of the questionlist		"questionLists": string[], // _id of the questionlist
	"extraFieldsData"?: [{ // extra data to provide to generate the report as defined in the ReportSpec		"extraFieldsData"?: [{ // extra data to provide to generate the report as defined in the ReportSpec
	"extraField": string, // ReportSpec.extraFields[]._id		"extraField": string, // ReportSpec.extraFields[]._id

Dieter: /* Models */

2022-11-12T16:15:42Z

Models

← Older revision		Revision as of 16:15, 12 November 2022
Line 458:		Line 458:
	"isNotificationScheduled"?: boolean, // use scheduling on moment defined in organisation or send immediately (defaults to false)		"isNotificationScheduled"?: boolean, // use scheduling on moment defined in organisation or send immediately (defaults to false)
	"ccSignedDocuments"?: undefined \| string, // extra email address to receive signed documents		"ccSignedDocuments"?: undefined \| string, // extra email address to receive signed documents
	"webhookUrl"?: string, // we send a ~~GET~~ request to: <webhookurl>?session=<session._id>		"webhookUrl"?: string, // we send a POST request to: <webhookurl> with JSON { session = <session._id> } in the body. This call is tried 3 times.
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Thomas.sonck: /* Sidefish v5 API Documentation */

2022-11-09T09:43:43Z

Sidefish v5 API Documentation

← Older revision		Revision as of 09:43, 9 November 2022
Line 1:		Line 1:
	= Sidefish v5 API Documentation =		= Sidefish v6 API Documentation =

	== General ==		== General ==

Thomas.sonck at 07:52, 28 October 2022

2022-10-28T07:52:04Z

← Older revision		Revision as of 07:52, 28 October 2022
Line 432:		Line 432:
	<syntaxhighlight lang="typescript">		<syntaxhighlight lang="typescript">
	class SessionRequestCreateObject {		class SessionRequestCreateObject {
	"code": string,		"code": string, // request via /api/v1/sessionrequests/generate-codes/<amount>
	"url": string,		"url": string, // example <mijn-kantoor>.sidefish.be/nl/#/<vragenlijst-identifier>/<session-code>
	"type": "qlist",		"type": "qlist",
	"customer": string, // _id		"customer": string, // _id of the customer
	~~"portfolio": string, // _id~~		"questionList": string, // _id of the questionlist
	"questionList": string, // _id		"extraFieldsData"?: [{ // extra data to provide to generate the report as defined in the ReportSpec
	"extraFieldsData"?: [{
	"extraField": string, // ReportSpec.extraFields[]._id		"extraField": string, // ReportSpec.extraFields[]._id
	"value": any,		"value": any,
Line 444:		Line 443:
	"notificationSms"?: {		"notificationSms"?: {
	"message"!: string,		"message"!: string,
	~~"language"?: string,~~
	},		},
	"notificationEmail"?: {		"notificationEmail"?: {
	"from"!: string,		"from"!: string, // the e-mail address of the user or the organisation sending the notification
	"bcc"?: string,		"bcc"?: string,
	"subject"!: string,		"subject"!: string,
	"message"!: string,		"message"!: string, // html email content
	~~"language"?: string,~~
	},		},
	"notificationReminder"?: {		"notificationReminder"?: {
	"from"!: string,		"from"!: string, // the e-mail address of the user or the organisation sending the notification
	"bcc"?: string,		"bcc"?: string,
	"subject"!: string,		"subject"!: string,
	"message"!: string,		"message"!: string, // html email content
	~~"language"?: string,~~
	},		},
	"isNotificationScheduled"?: boolean,		"isNotificationScheduled"?: boolean, // use scheduling on moment defined in organisation or send immediately (defaults to false)
	"ccSignedDocuments": undefined \| string,		"ccSignedDocuments"?: undefined \| string, // extra email address to receive signed documents
			"webhookUrl"?: string, // we send a GET request to: <webhookurl>?session=<session._id>
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Dieter: /* C. API KEY */

2022-10-27T14:16:21Z

C. API KEY

← Older revision		Revision as of 14:16, 27 October 2022
Line 74:		Line 74:
	1. Get the API key for your user via the Sidefish Platform under "my account".		1. Get the API key for your user via the Sidefish Platform under "my account".

	2. Use the ~~resulting token a cookie called access_token~~:<syntaxhighlight lang="http">		2. Use the API key in the request header as:<syntaxhighlight lang="http">
	x-api-key: 123456789		x-api-key: 123456789
	</syntaxhighlight>		</syntaxhighlight>

Thomas.sonck at 13:30, 27 October 2022

2022-10-27T13:30:16Z

← Older revision		Revision as of 13:30, 27 October 2022
Line 14:		Line 14:


	To summarize: a user is part of an organisation. A user has one or more portfolios with customers inside. A user also has question lists that are shared across his organisation. A session request ~~can be made by~~ a ~~user for~~ a customer, ~~using a specific questionlist~~.		To summarize: a user is part of an organisation. A user has one or more portfolios with customers inside. A user also has question lists that are shared across his organisation. An organisation has a customer template defining dynamic fields for customer data. An organisation also hass communication templates for personalized dynamic automatic communications to users and customers. A user can invite a customer to answer a question list by creating a session request, linked to a question list. A question list has a report specification, which is a template to generate a report document after the customer completed his session request. This report spec contains dynamic customer data fields, signature positions, or any other dynamic data that we provide.

	== Endpoint ==		== Endpoint ==

Thomas.sonck at 13:24, 27 October 2022

2022-10-27T13:24:19Z

← Older revision		Revision as of 13:24, 27 October 2022
Line 10:		Line 10:
	The scheme below shows a simplified data model.		The scheme below shows a simplified data model.

	[[File:Sidefish-data-~~scheme~~.jpg]]		[[File:Sidefish-data-sheme.jpg]]

Thomas.sonck at 13:20, 27 October 2022

2022-10-27T13:20:23Z

← Older revision		Revision as of 13:20, 27 October 2022
Line 10:		Line 10:
	The scheme below shows a simplified data model.		The scheme below shows a simplified data model.

	[[File:Sidefish-data-scheme.jpg]]To summarize: a user is part of an organisation. A user has one or more portfolios with customers inside. A user also has question lists that are shared across his organisation. A session request can be made by a user for a customer, using a specific questionlist.		[[File:Sidefish-data-scheme.jpg]]


			To summarize: a user is part of an organisation. A user has one or more portfolios with customers inside. A user also has question lists that are shared across his organisation. A session request can be made by a user for a customer, using a specific questionlist.

	== Endpoint ==		== Endpoint ==

Thomas.sonck: /* General */

2022-10-27T13:20:11Z

General

← Older revision		Revision as of 13:20, 27 October 2022
Line 7:		Line 7:

	Errors are returned with corresponding HTTP statuses, like 400, 403, 404 , etc. The response body contains an error description.		Errors are returned with corresponding HTTP statuses, like 400, 403, 404 , etc. The response body contains an error description.

			The scheme below shows a simplified data model.

			[[File:Sidefish-data-scheme.jpg]]To summarize: a user is part of an organisation. A user has one or more portfolios with customers inside. A user also has question lists that are shared across his organisation. A session request can be made by a user for a customer, using a specific questionlist.

	== Endpoint ==		== Endpoint ==

Thomas.sonck at 12:23, 27 October 2022

2022-10-27T12:23:39Z

← Older revision		Revision as of 12:23, 27 October 2022
Line 409:		Line 409:
	\|An object containting your user info.<syntaxhighlight lang="typescript">		\|An object containting your user info.<syntaxhighlight lang="typescript">
	[		[
	~~QuestionList~~: {		SessionRequestCreateObject: {
	~~_id: "12345789",~~
	...		...
	},		},
	]		]
	</syntaxhighlight>		</syntaxhighlight>
	~~\|An object containting your user info.<syntaxhighlight lang="typescript">~~
	[
	~~QuestionList: {~~
	~~_id: "12345789",~~
	~~...~~
	},
	]
	~~</syntaxhighlight>~~
	\|}
	~~{\| class="wikitable"~~
	~~!Endpoint~~
	~~!Method~~
	~~!Request Body~~
	~~!Response Body~~
	\|-
	~~\|/sessionrequests~~
	~~\|POST~~
	~~\|SessionRequestCreateObject~~
	\|<syntaxhighlight lang="ts">		\|<syntaxhighlight lang="ts">
	{		{
Line 440:		Line 421:
	</syntaxhighlight>		</syntaxhighlight>
	\|}		\|}
	=== ~~SessionRequestCreateObject~~ ===		=== Models ===
	<syntaxhighlight lang="ts">		<syntaxhighlight lang="typescript">
	{		class SessionRequestCreateObject {
	"code": string,		"code": string,
	"url": string,		"url": string,