Skip to content
Florian Lorrain edited this page Aug 14, 2014 · 8 revisions

Welcome to Responsys Api Client !

This wiki is intended to help you understand the purpose and the actions that this client can make.

You will find functional, concepts and technical replies to your questions. If you need any more help, please feel free to ask in the repository issue section.

Overview

Our client helps you communicate to your dedicated Responsys system. It uses the Interact API provided by Oracle for a couple of recurrent common actions in order to integrate them easily into your back-end.

Important notes:

  • Responsys is a private service which is based on a commercial contract. You cannot test it unless you have a demo account or a contract account. Please contact Oracle for further information.
  • You will need your own credentials in order to use this Gem and to authenticate with your identity to the API.
  • Your information are kept secret and will not be used to any third party.
  • Please read the documentation before any action which would mess up your Responsys account.

Requirements:

  • This client is using the Ruby power. It requires a Ruby 1.9 environment or newer.
  • Enjoy !

Current supported concepts

The client is based upon the official documentation of Interact API v6.20. The same methods specifications are available inside the GEM.

But because the concepts in the API are not that straightforward, we tried to make it more user friendly by creating higher level objects that use these methods and make them more simple to use.

Interact API methods

Just a reminder of the concepts of the API. For further information, please refer to the documentation.

  • Authentication [TODO]
  • Folder [TODO]
  • List [TODO]

Client generic concepts

We're here to help you. Focus on your app and let us provide you nice simple objects to manipulate.

  • Authentication
  • Content [TODO]
  • Member [TODO]

Integration

Responsys Api can be combined with Rails or Ruby scripts.

TODO : SCHEMA

TODO : Example

create a sample Rails project which would connect to the API and show abilities of the GEM as well as configuration, integration, ...