Client specification Authentication

Before any action with the API you have to be identified with your credentials. A session will be attached to any call you make from the client.

Follows the different action you can do with the client.

Configuration

The only thing required is to provide the configuration with the credentials. If you have a Rails environment, this is recommended to put it in an initializer.

# config/initializers/responsys_api.rb

Responsys.configure do |config|
  config.settings = {
    :username => "your_responsys_username",
    :password => "your_responsys_password",
    :wsdl => "https://wsXXXX.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl"
  }
end

These informations are provided by Oracle and will be used at log in.

NOTE:

Your credentials must be kept secret to protect your data.

Log in and Log out

You have nothing to worry about it. The GEM handles that for you. You should not use the login / logout methods by yourself.

The log in action is intended to get in return a session identification which will be given to the next API calls.

Logging in and logging out each time you need to make an action is not recommended. The GEM has not been thought that way in order to avoid giving you delays in your application.

Instead a new session is created when the current one is outdated.