Glossary of Terms
This index provides a list of terms and setting along with their definitions and/or purpose within API Services. Terms are arranged alphabetically within the part of the application they reside. For specific use cases and context, please refer to the specific pages after each table.
API Services
| Term | Definition |
|---|---|
Access Token | A string provided by the External Application's Authorization Server to be used to gain access to the External Application. |
| API Service Key | The name of the API Service in Fonteva code. |
| Auth Type | The type of Authentication required for the outgoing API Call to the External Application. |
| Authentication Service | The field that sends VendorAuthenticationClass from Fonteva to the External Application. This field can also be used to provide custom authentication parameters. |
| buildAuthorizationCodeUrl | This custom Authentication Service parameter provides the specific URL to get the Access Token from the External Application. This method takes a map value and returns a string. |
| buildTokenUrl | This custom Authentication Service parameter builds a redirect that allows the user to get the Initial Token from the External Application. This method returns a page reference. |
| Description | A brief description of what the specific API Service does. |
| Display Name | The API Service name displayed in the Spark Framework UI |
| Endpoint | The base endpoint for all API Calls |
| Endpoint URL | The URL which Fonteva uses to access specific services on an External Application, e.g.: https://api.twitter.com |
| extractAccessToken | This custom Authentication Service method tells Fonteva to extract the Access Token. This method takes a map value and returns a string. |
| Icon Image URL | The URL of the image you want to use for your API Service icon. |
| Initial Token | The string provided by the Authentication Server in order to receive the Access Token. Not all External Applications require this. |
| VendorAuthenticationClass | The global default parameter for standard authentication types. |
See Setting Up A New API Service for more information.
API Groupings
| Term | Definition |
|---|---|
| API Object | The data you want to be nested within the parent object. |
| API Resource | The specific API Resource containing the parent object. |
| Target Related Lookup Field | The field that relates the parent object to the data you want nested. |
See API Groupings for more information.
API Resources
| Term | Definition |
|---|---|
API Object | The object in the JSON document your API Resource is looking for. |
| API Object Key Field | The value that uniquely identifies the field in an External Application. |
| API Resource Name | The name of the API Resource displayed in the UI. |
getLastJSONResponse getPreviousJSONResponse | These methods pull either the previous or last parsed JSON response received by your Fonteva application. |
getLastRawResponse | This method pulls the last JSON document without the mapping. |
| ReST Endpoint | A ReST endpoint provides a way to map a URI and HTTP method to a ReSTful resource. ReSTful resources are stateless and create cached responses. |
SObject | Any persisted object type that can be stored in a Salesforce database. |
| Target SObject | The target SObject for the information requested from the External Application. |
| Target SObject Key Field | The field that uniquely identifies the specific record in the External Application. |
| URI Verb | The method needed to access the information. |
See API Resources for more information.
API Mapping
| Term | Definition |
|---|---|
| API Field | The JSON value you want to map to in the External Application. |
| Relationship Field | The related field between your target field in the Fonteva app and the field in an External Application. |
| Target Field | The destination field in your Fonteva app. |
See API Mapping for more information.
API Variables
| Term | Definition |
|---|---|
| API Field | The name of the variable used in the outgoing API call. |
| Field Value | The value of the variable used in the outgoing API call. |
| Default Value | The value that is set if no value is entered by the user. |
See API Variables for more information.
API Service Connections
| Term | Definition |
|---|---|
| Authorization Code URL | The URL used by the Authorization Server to return an Auth Code. |
| Client ID | The specific ID used by the Client Server. |
| Client Secret | The string that verifies the identity of the Client Server. |
| Connection Name | The displayed name of the connection. |
| HTTP Method to Get Token | The HTTP verb used to retrieve the token from the Authorization Server. |
| Login Dialog URL | The URL used to initially request the Access Token |
| Password | The user's password for the Resource Server. |
| Refresh Token URL | The URL needed to retrieve a Refresh Token. |
| Request Token URL | The URL needed to request an Access Token from the Authorization Server. |
| Scope | The scope of the access requested by your Fonteva app. |
| User Name | The user's username for the Resource Server. |
See API Service Connections for more information.
Dispatch Objects
| Term | Definition |
|---|---|
API Resource | The API Resource you wish to use for this trigger. |
| HTTP Verb | The HTTP verb needed to update the External Application. |
| Name | The displayed name of the Dispatch Object. |
| SObject Name | The name of the additional SObject that should be sent to the External Application. |
See Dispatch Objects for more information.