|
|
|
API Security
The API Security screen allows you to authorise one or more third-party developers and products and Freeway Mobility users to have access to your Ostendo API Service.
It also enables you to generate the API key for each developer-product / Freeway Mobility user.
For Freeway usage, it is mandatory to have separate API Security records for Employees, for Customers, and for SubContractors. This is to prevent customers and subcontractors from "accidentally" accessing Freeway/Ostendo as an employee.
Entry and Display fields
Developer Name: Enter the name of the Developer.
Product Name: Enter the name of the Product or Application.
Expiry Date: The date this authorisation will expire.
SQL Allowed: Tick this box if this Application is allowed to use SQL to query the Ostendo database.
API Key for: Select one of the following styles:
- Internal Generally for internal Freeway users only (Employees rather than third party users)
- Mobility B2B For Customer Freeway users
- Mobility SubContractor For Subcontractor Freeway users
Multiple employees can share the same Internal API Security record.
Similarly, multiple customers can share the same Mobility B2B API Security record and multiple subcontractors can share the same Mobility SubContractor API Security record.
Third-party software can use any of the above styles. Click here to download the Ostendo API Service Document which explains how an external third party application can connect to an Ostendo database using the Ostendo API Service.
Buttons
Close: This will close the API Security screen. If you have any unsaved data then you will be asked if you wish to save it before the screen is closed.
Add: This will send the cursor to a new line for entry of a new API Security record.
Save: This will save the current data without exiting the screen
Cancel: Any changes made since the screen was opened or the last time the ‘Save’ Button was pressed will be lost.
Delete: This will immediately delete the current record from the list.
API Key: This will generate the URL-encoded API Key for the current Product/Application.
Fast Code (Used for Freeway Only): This will generate a short code which can be sent to a Freeway mobility user. When the mobility user keys in this Fast Code into the app, it will pull the actual API Key and the Freeway License key into the app. This simplifies the process of loading the Keys into the Freeway mobility app.
The Fast Code can be used multiple times until its expiry as specified in Mobility Rules.
Fast Codes are normally generated via the Employee Mobility Settings screen or the Customer Mobility Screen.