yodlee.CobrandApi

All URIs are relative to http://localhost

Method	HTTP request	Description
cobrand_login	POST /cobrand/login	Cobrand Login
cobrand_logout	POST /cobrand/logout	Cobrand Logout
create_subscription_event	POST /cobrand/config/notifications/events/{eventName}	Subscribe Event
delete_subscribed_event	DELETE /cobrand/config/notifications/events/{eventName}	Delete Subscription
get_public_key	GET /cobrand/publicKey	Get Public Key
get_subscribed_events	GET /cobrand/config/notifications/events	Get Subscribed Events
update_subscribed_event	PUT /cobrand/config/notifications/events/{eventName}	Update Subscription

cobrand_login

CobrandLoginResponse cobrand_login(cobrand_login_request)

Cobrand Login

The cobrand login service authenticates a cobrand.
Cobrand session in the response includes the cobrand session token (cobSession)
which is used in subsequent API calls like registering or signing in the user.
The idle timeout for a cobrand session is 2 hours and the absolute timeout is 24 hours. This service can be
invoked to create a new cobrand session token.
Note: This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.
The content type has to be passed as application/json for the body parameter.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.CobrandApi(api_client)
    cobrand_login_request = yodlee.CobrandLoginRequest() # CobrandLoginRequest | cobrandLoginRequest

    try:
        # Cobrand Login
        api_response = api_instance.cobrand_login(cobrand_login_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CobrandApi->cobrand_login: %s\n" % e)

Parameters

Name	Type	Description	Notes
cobrand_login_request	CobrandLoginRequest	cobrandLoginRequest

Return type

CobrandLoginResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y800 : Invalid value for cobrandParam	-
401	Y003 : Account is locked, contact Yodlee customer care<br>Y001 : User name and password required	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cobrand_logout

cobrand_logout()

Cobrand Logout

The cobrand logout service is used to log out the cobrand.
This service does not return a response. The HTTP response code is 204 (Success with no content).
Note: This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.CobrandApi(api_client)
    
    try:
        # Cobrand Logout
        api_instance.cobrand_logout()
    except ApiException as e:
        print("Exception when calling CobrandApi->cobrand_logout: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
204	Logout successful	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_subscription_event

create_subscription_event(event_name, event_request)

Subscribe Event

Refer POST /configs/notifications/events/{eventName}.
The subscribe events service is used to subscribe to an event for receiving notifications.
The callback URL, where the notification will be posted should be provided to this service.
If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.
Customers can subscribe to REFRESH,DATA_UPDATES and AUTO_REFRESH_UPDATES event.

Notes:
This service is not available in developer sandbox/test environment and will be made available for testing in your dedicated environment, once the contract is signed.
The content type has to be passed as application/json for the body parameter.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.CobrandApi(api_client)
    event_name = 'event_name_example' # str | eventName
event_request = yodlee.CreateCobrandNotificationEventRequest() # CreateCobrandNotificationEventRequest | eventRequest

    try:
        # Subscribe Event
        api_instance.create_subscription_event(event_name, event_request)
    except ApiException as e:
        print("Exception when calling CobrandApi->create_subscription_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_name	str	eventName
event_request	CreateCobrandNotificationEventRequest	eventRequest

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
201	OK	-
400	Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_subscribed_event

delete_subscribed_event(event_name)

Delete Subscription

Refer DELETE /configs/notifications/events/{eventName}.
The delete events service is used to unsubscribe from an events service.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.CobrandApi(api_client)
    event_name = 'event_name_example' # str | eventName

    try:
        # Delete Subscription
        api_instance.delete_subscribed_event(event_name)
    except ApiException as e:
        print("Exception when calling CobrandApi->delete_subscribed_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_name	str	eventName

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
400	Y803 : eventName required	-
401	Unauthorized	-
204	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_public_key

CobrandPublicKeyResponse get_public_key()

Get Public Key

Refer GET /configs/publicKey.
The get public key service provides the customer the public key that should be used to encrypt the user credentials before sending it to Yodlee.
This endpoint is useful only for PKI enabled.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.CobrandApi(api_client)
    
    try:
        # Get Public Key
        api_response = api_instance.get_public_key()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CobrandApi->get_public_key: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CobrandPublicKeyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_subscribed_events

CobrandNotificationResponse get_subscribed_events(event_name=event_name)

Get Subscribed Events

Refer GET /configs/notifications/events.
The get events service provides the list of events for which consumers subscribed
to receive notifications.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.CobrandApi(api_client)
    event_name = 'event_name_example' # str | eventName (optional)

    try:
        # Get Subscribed Events
        api_response = api_instance.get_subscribed_events(event_name=event_name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CobrandApi->get_subscribed_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_name	str	eventName	[optional]

Return type

CobrandNotificationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_subscribed_event

update_subscribed_event(event_name, event_request)

Update Subscription

Refer PUT /configs/notifications/events/{eventName}.
The update events service is used to update the callback URL.
If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.
Note: The content type has to be passed as application/json for the body parameter.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.CobrandApi(api_client)
    event_name = 'event_name_example' # str | eventName
event_request = yodlee.UpdateCobrandNotificationEventRequest() # UpdateCobrandNotificationEventRequest | eventRequest

    try:
        # Update Subscription
        api_instance.update_subscribed_event(event_name, event_request)
    except ApiException as e:
        print("Exception when calling CobrandApi->update_subscribed_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_name	str	eventName
event_request	UpdateCobrandNotificationEventRequest	eventRequest

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
400	Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl	-
401	Unauthorized	-
204	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CobrandApi.md

Latest commit

History

CobrandApi.md

File metadata and controls

yodlee.CobrandApi

cobrand_login

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cobrand_logout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_subscription_event

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_subscribed_event

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_public_key

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_subscribed_events

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_subscribed_event

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details