Once you have learned about authentication, and determining your base URL, you can start making API requests. A basic request has several components not including authentication. An Oracle Eloqua API request follows the form:
[Verb] [base URL]/API/[APIName]/[APINumber]/[endpoint]
[APIName] is the name of the API, such as 'rest' or 'bulk', and "
[APINumber]" is the version of the API, such as '1.0' or '2.0'.
Therefore an example of a complete request would be as follows:
In the sections below you will find articles explaining different request components. For a video demonstration of these concepts, refer to the Sending Requests topic in the Eloqua Developer Help Center.
Eloqua's API services support four different methods or "verbs": POST, GET, PUT and DELETE. In terms of database functions, these HTTP verbs correspond to the basic operations of "CRUD": create, read, update and delete. Learn more about HTTP verbs.
- GET is used to retrieve a representation or API entity from a resource. Can be used to retrieve one or more entities.
- POST is used to create a new resource.
- PUT is used to update a resource.
- DELETE is used to delete a resource.
Endpoints allow access to Oracle Eloqua resources and operations. Each resource/operation is associated with a specific URL. Endpoints have can be accessed and manipulated through HTTP verbs, but not all verbs are valid for all endpoints.
Note:An endpoint is sometimes referred to as a "URI" or uniform resource identifier.
For example, performing a GET request on the REST 1.0
assets/emails endpoint will return a list of all the emails in your instance's database. However, you cannot perform a POST request on this endpoint.
Learn how to form a request using cURL.