Difference between revisions of "Integration/Interface"
old>Admin (Created page with 'Interfaces allow users to access a certain facet of the system Interfaces allow access to the system with preset values for * Wrapper * Stylesheet * Template * Language * User c…') |
m (10 revisions imported) |
||
| (9 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
=== Understanding interfaces === | |||
Interfaces allow access to the system with preset values for | Interfaces allow access to the system with preset values for | ||
| Line 8: | Line 8: | ||
* User context | * User context | ||
When accessing the interface the user is redirceted to the main page with the correct parameters set. In case the user context is active, a session with a matching user profile is also created i process. | When accessing the interface the user is redirceted to the main page with the correct parameters set. In case the user context is active, a session with a matching user profile is also created i process. | ||
The following types of record operations are allowed | |||
* Create new records | |||
* Update an existing record | |||
Detailed information about the options can be found here: [[Interfaces]] | |||
=== Create operations === | |||
Create operations require no additional security information and can be used directly. | |||
URL for testing the interface: | |||
http://[server name]/[application]/webinterface?[interfacename] | |||
=== Update operations === | |||
When updating an existing record a security token must be passed along to the interface: | |||
* The right data is displayed for the user | |||
* Bind user session to this piece of data | |||
A security token contains | |||
* a reference to the record | |||
* a timestamp shen the token was issued | |||
* a signature that guarantees that the server issued the token | |||
URL for testing the interface: | |||
http://[server name]/[application]/webinterface?[interfacename]=[security token] | |||
Security tokens can be generated in various ways | |||
* Create a status action that generates a notification | |||
* Administrator tool: Designer > Modules > Admin Services > BuildSecuityToken | |||
* Add the special "Token display" field to a solution | |||
=== Questionaires and email invitations === | |||
Generation of security tokens are closly tied to the use of questionaires and status actions. | |||
The guide [[Tutorial/Questionaires|Questionaires]] covers such an example. | |||
Latest revision as of 12:52, 10 December 2021
Understanding interfaces
Interfaces allow access to the system with preset values for
- Wrapper
- Stylesheet
- Template
- Language
- User context
When accessing the interface the user is redirceted to the main page with the correct parameters set. In case the user context is active, a session with a matching user profile is also created i process.
The following types of record operations are allowed
- Create new records
- Update an existing record
Detailed information about the options can be found here: Interfaces
Create operations
Create operations require no additional security information and can be used directly.
URL for testing the interface:
http://[server name]/[application]/webinterface?[interfacename]
Update operations
When updating an existing record a security token must be passed along to the interface:
- The right data is displayed for the user
- Bind user session to this piece of data
A security token contains
- a reference to the record
- a timestamp shen the token was issued
- a signature that guarantees that the server issued the token
URL for testing the interface: http://[server name]/[application]/webinterface?[interfacename]=[security token]
Security tokens can be generated in various ways
- Create a status action that generates a notification
- Administrator tool: Designer > Modules > Admin Services > BuildSecuityToken
- Add the special "Token display" field to a solution
Questionaires and email invitations
Generation of security tokens are closly tied to the use of questionaires and status actions.
The guide Questionaires covers such an example.