Work with your REST API Client
Because REST APIs use HTTP methods to send and receive content, you can test REST APIs using any programming language or tool that supports sending and receiving HTTP messages. So, let's first choose a tool for making HTTP requests.
Choosing a REST API Client
-
A standalone client, such as Postman or Advanced REST Client
-
Your connecting application's client
-
The cURL command-line utility
-
Test the username, password, and request URL for your REST API account.
-
Perform
view
anddescribe
actions to learn more about REST resources, attributes, and parameters. -
Use the collected information to construct and send various types of HTTP requests, such as those to create, update, or delete records.
Using cURL to Send HTTP Requests
In our examples, we use cURL, a popular command-line utility for transferring data using URL syntax, to send requests to REST services. cURL is available in most UNIX, Windows, and Macintosh environments. For details, see Installing the cURL Command-Line Tool on Windows.
The following table describes commonly used cURL options that you can use for REST services.
Option | Description |
---|---|
-user |
Specifies the user name and password for server authentication. |
-d |
Sends the specified data (a JSON request body) to the server. If you begin the data with the @ sign, then @ must be followed by a file name to read the data from. |
-H |
Specifies an extra HTTP header in the request. To specify multiple headers, precede each header with the
Examples:
|
-output |
Writes the output to a file instead of to |
-X |
Specifies the request method to use when communicating with the HTTP server. The default method is GET. |
The following table shows Oracle Applications Cloud examples of the GET, PATCH, and POST operations using cURL.
Operation | cURL Command Example |
---|---|
Use |
|
Use |
|
Use |
|
Using REST API Clients to Send HTTP Requests
You can use standalone clients, third-party browser extensions, or add-ons, such as the Advanced REST Client, to send HTTP requests. The following table includes examples of the GET, POST, and PATCH operations using a REST API client.
Operation | Response/Payload Example |
---|---|
GET: Get an account. Request URL: |
|
POST: Create a new role. Request URL: |
|
PATCH: Update the work email of an employee. Request URL: |
|
With an understanding of how your REST API client works, you can next review for a sample workflow that demonstrates how to create, update, verify, and retrieve information about a record.