Difference between revisions of "Interfaces"
Jump to navigation
Jump to search
old>Admin |
old>Admin |
||
| Line 3: | Line 3: | ||
For a more detailed description, please resd: [[Integration/Interface#Understanding_interfaces|Understanding interfaces]] | For a more detailed description, please resd: [[Integration/Interface#Understanding_interfaces|Understanding interfaces]] | ||
=== Basic configuration | === Basic configuration === | ||
An interface has the following configuration options | An interface has the following configuration options | ||
* Interface URL | * Interface URL | ||
| Line 17: | Line 17: | ||
** Allow INSERT of new records | ** Allow INSERT of new records | ||
=== | === Email tokens for access to existing records === | ||
A common usage is sending email tokens to external users. | A common usage is sending email tokens to external users. | ||
| Line 25: | Line 25: | ||
* '''Token expiry''': Maximum allowed age of the token | * '''Token expiry''': Maximum allowed age of the token | ||
=== | === Other interface options === | ||
Control what happens after an update or insert operation | Control what happens after an update or insert operation | ||
Revision as of 11:16, 21 November 2013
Interfaces are access points for external users (someone using the system without a login).
For a more detailed description, please resd: Understanding interfaces
Basic configuration
An interface has the following configuration options
- Interface URL
- Unique name of the service
- How should the interface behave
- Wrapper: Mimic the looks of another website
- Template: Basic page structure
- Stylesheet: Look and feel of the page
- Language: Default language set on page
- What is the external user allowed to do
- Proxy user profile
- Allow UPDATE of existing records
- Allow INSERT of new records
Email tokens for access to existing records
A common usage is sending email tokens to external users.
Tokens will allow a certain user to update the content of a certain record. Usually these are tied together, where the email of the user is a field in the record.
Tokens contain a timestamp, so it is possible to invalidate the token after a specified amount of time
- Token expiry: Maximum allowed age of the token
Other interface options
Control what happens after an update or insert operation
- Succes message: Displayed message (if not using questionaire interface)
- Failure message: Displayed message (if not using questionaire interface)
- Redirect: URL to send user to after updating/inserting their data
Extra security features
- CAPTCHA: User must take human test before using the interface (prevents robots from injecting data)
- IP filter: Specificy which IP's are allowed to use the interface (prevent users from known problem countries)