Skip to content

README.md

Latest commit

 

History

History
65 lines (56 loc) · 2.19 KB

README.md

File metadata and controls

65 lines (56 loc) · 2.19 KB

eloqua-ruby-request

Eloqua Ruby Request is a client for Eloqua's REST API. It supports GET, POST, PUT and DELETE operations and the response from each method contains the raw string response from the HTTP request.

Usage

GET

    require('eloqua-ruby-request')
    request = EloquaRequest.new('site', 'user', 'password', 'baseUrl')
    response = request.get('/assets/emails?search=Demand*&page=1&count=50&depth=minimal')

POST

    require('eloqua-ruby-request')
    request = EloquaRequest.new('site', 'user', 'password', 'baseUrl')
    data = ...
    response = request.post('/assets/email', data)

PUT

    require('eloqua-ruby-request')
    request = EloquaRequest.new('site', 'user', 'password', 'baseUrl')
    data = ...
    response = request.put('/assets/email/123', data)

DELETE

    require('eloqua-ruby-request')
    request = EloquaRequest.new('site', 'user', 'password', 'baseUrl')
    response = request.delete('/assets/email/123')

Endpoint URL

To determine the base url, you can use the following endpoint : login.eloqua.com/{id}
The endpoint, when called with basic authentication, will return details about the URLs for the various APIs.

{
    "site": {
        "id": 42,
        "name": "SampleInstall"
    },
    "user": {
        "id": 314,
        "username": "Fred Sakr",
        "displayName": "Fred Sakr",
        "firstName": "Fred",
        "lastName": "Sakr",
        "emailAddress": "fred.sakr@eloqua.com"
    },
    "urls": {
        "base": "https://www05.secure.eloqua.com",
        "apis"	...
	}
}

License

Copyright [2012] [Fred Sakr]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.