*Introduction*
Yodlee is a service that allows consumers to securely consolidate and manage
their financial information on the web. The Yodlee platform uniquely
harnesses financial data to create more personalized and engaging digital
experiences. Yodlee is the preferred platform to inspire and enable global
financial innovation.
*Connector Summery*
• Connector Name: Yodlee-connector-1.0.0
• Version: 1.0.0
• Technology: REST
• API Version: v1.0
• API URL:
https://developer.yodlee.com/Indy_FinApp/Aggregation_Services_Guide/REST_API_Reference
*Authentication*
session token / user name, password used for the authentication
Selected Methods (52) for version 1.0.0
*Core Services:*
• *init*– Config operation.
• *coblogin *– This REST API accepts the input parameters below to
authenticate the cobrand.
• *categorizeTransactions *- This REST API facilitates manual
categorization and re-categorization by the consumer.
• *clearUserTransactions *- This REST API provides a mechanism by
which the
callee can clear the transaction search results obtained as a result of
consumer's transaction search request by calling the
executeUserSearchRequest API.
• *executeUserSearchRequest *- This REST API initiates a
transaction
search and returns the first page result.
• *getTransactionCategoryTypes *- This REST API retrieves the
supported
TransactionCategoryTypes.
• *getUserTransactions *- This REST API provides a mechanism by
which the
callee can paginate the search results obtained as a result of user's
transaction search request by calling the executeUserSearchRequest API.
• *getUserTransactionCategories *- This REST API returns an array
of
category objects having the transaction category names for the consumer
along with the parent categories (i.e., super categories) and the child
categories (i.e., subcategories) created by the consumer for the category.
• *getUserInfo *- This REST API provides additional information
related to
a specific consumer.
• *login *- This REST API enables the consumer to log in to the
application.
• *logout *- This REST API logs out the consumer from the Yodlee
software
platform.
• *register *- This REST API accepts a consumer's details to
register the
consumer in the Yodlee system. User profile information and user preferences
can also be set during the registration process.
• *unregister *- This REST API unregisters the consumer from the
Yodlee
software platform.
• *updateEmail *- This REST API updates the consumer's email
address in the
user profile.
• *validateUser *- This REST API verifies whether the given user
name is
valid for a specific cobrand. It will return false if such a user does not
exist for that cobrand or if the user's status is deleted. Otherwise it will
return true.
• *manageUserCategories *- This REST API can be used to create,
update or
delete the User Categories.
*Container-based Services*
• *activateItemAccount *- This REST API reactivates the required
Item
Account, which is in an inactive state. Item Account refers to a specific
financial account aggregated by the consumer.
• *addItemForContentService *- This REST API adds the member item
for a
specific content service (i.e., John Doe wants to aggregate his banking
accounts held in IQ Bank).
• *addManualAccount *- This REST API adds a manual (AKA custom)
account to
the consumer's Yodlee account. The credentials and the data associated with
the manual account can also be set.
• *getItemSummaries *- This REST API retrieves the list of all
the accounts
that the consumer has aggregated.
• *getItemSummaryForItem *- This REST API retrieves the details
about a
specific item providing details to the specified extent.
• *getItemSummariesWithoutItemData *- This REST API retrieves the
details
about a list of items without providing item data information for them.
• *getLoginFormForContentService *- This REST API provides the
login form
associated with the requested Content Service ID.
• *getAllContentServices *- This REST API returns all the content
services
for the given cobrand.
• *getContentServiceInfo *- This REST API provides the details of
the
content service associated with the given content service id.
• *getContentServicesByContainerType *- This REST API returns the
content
services associated with the given container for the specific cobrand.
• *getRefreshInfo *- This REST API provides an array of
RefreshInfo objects
corresponding to the items belonging to the specific consumer.
• *getMFAResponse *- This REST API retrieves the intermediate
response for
MFA enabled sites and provides the MFA related field information that can be
one of the following types: image, security question, or token.
• *isItemRefreshing *- This REST API verifies whether the given
memItemId
is currently being refreshed.
• *startRefresh *- This REST API attempts to refresh the
specified item.
If the item specified cannot be refreshed, the returned refreshStatus
indicates the reason.
• *stopRefresh *- This REST API stops the refresh for the given
item for
the specific consumer if an instant refresh is in progress.
• *putMFARequest *- This REST API is to be used to send the
intermediate
response given by the consumer to the site.
• *removeItem *- This REST API removes an item which is an account
aggregated by the consumer.
• *updateCredentialsForItem *- This REST API updates the
credentials
information for a specific Member Item.
*Site-based Services*
• *addSiteAccount *- This REST API adds a member site account
associated
with a particular site.
• *getAllSiteAccounts *- This REST API provides the account
information for
all the accounts aggregated from various sites by a specific consumer.
• *getAllSites *- This REST API returns all the sites in the
system that
are enabled for the specific cobrand.
• *getItemSummariesForSite *- This REST API retrieves the list of
aggregated accounts based on the internal identifier for the consumer's
account at the site.
• *getMFAResponseForSite *- This REST API retrieves the
intermediate
response for MFA enabled sites and provides the MFA related field
information that can be one of the following types: image, security
question, or token.
• *getPopularSites *- This REST API provides the information
about the
sites that are enabled for the Yodlee customer associated with the required
consumer and at the required level of popularity.
• *getSiteAccountMFAQuestionsAndAnswers *- This REST API returns
MFA
questions and answers that are related to a member site account, given a
member site account identifier.
• *getSiteAccounts *- This REST API returns the information
related to the
specified accounts aggregated by the consumer.
• *getSiteInfo *- This REST API provides the information
regarding a site
based on the specified filter.
• *getSiteLoginForm *- This REST API provides the login form
associated
with the requested site.
• *getSiteRefreshInfo *- This REST API returns the refresh related
information related to a specific member site account.
• *getSuggestedSites *- This REST API retrieves the suggested
sites for a
user.
• *putMFARequestForSite *- This REST API is to be used to send the
intermediate response given by the user, to the site.
• *removeSiteAccount *- This REST API removes a specific site
account for
this consumer.
• *searchSite *- This REST API accepts the search string to
search for
sites.
• *startSiteRefresh *- This REST API attempts to refresh the
specified
member site account.
• *stopSiteRefresh *- This REST API stops the instant refreshes,
if any,
that are in progress for the consumer.
• *updateSiteAccountCredentials *- This REST API updates the
credentials
information for an existing member site account.
--
View this message in context:
http://wso2-oxygen-tank.10903.n7.nabble.com/Connector-Yodlee-tp90719.html
Sent from the WSO2 Architecture mailing list archive at Nabble.com.
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
