Create an HTTP Service

0 %

Create an HTTP Service

Details

Create an HTTP Service

Requires Customer/Partner License

2019-12-10

Beginner

15 min.

Create an HTTP service in the ABAP environment that can be called from the browser.

You will learn

How to create an HTTP service that can be accessed from a browser
How to return system data using a (whitelisted) ABAP utility class
How to add basic authentication (user and password) to the service, by adding an inbound Communication Scenario, Arrangement, System, and User. It can then be consumed from another SAP System compliantly.

Note if you are working in S/4HANA:
ICF services are direct entry points into the ABAP system via the HTTP protocol. Implementing ICF services is a security-critical task with implications on the system and landscape configuration.

Therefore, to follow the best practices adopted by SAP internally, consider implementing your service as an OData service.

Step 1: Create an HTTP service

Select a package and choose New > Other Repository Object from the context menu:
Enter the filter text HTTP and choose Next:
Enter a **Name: ** and Description for your service and choose Next:
Choose or create a transport request:

The new HTTP service is displayed on a new tab. The handler class and URL are generated automatically, in the form:
https://<server:port>/sap/bc/http/sap/<service_name>?sap-client=100

Image depicting step-1e-new-service-created

Done

Log on to answer question

Step 2: Implement the handler class

Now, you will implement the handler class, starting with a simple text output.

Open the handler class by clicking on it:
The structure of the class and the interfaces statement for IF_HTTP_SERVICE_EXTENSION are generated automatically.
Go to the class implementation section and insert the following statement in the method:
response->set_text('Hello again!').

Done

Log on to answer question

Step 3: Save and activate

Save (Ctrl+S) and activate (Ctrl+F3) your class.

Done

Log on to answer question

Step 4: Test the service

Test your service in the browser by clicking the URL link:
If necessary, log in again. The preview open automatically in a new tab and display something like this:

Done

Log on to answer question

Step 5: Add system date to the method

View Full Instructions

Now you will add to the method by fetching the date from the back end first.

In the ABAP environment, you can only use whitelisted APIs. Therefore, you cannot use SY-DATUM. Instead, you call the appropriate method of the class CL_ABAP_CONTEXT_INFO.

You then cast this date variable to a string variable and output that as before.

Delete the statement response->set_text('Hello again!'). and add the following to your code:

DATA(system_date) = CL_ABAP_CONTEXT_INFO=>get_system_date( ).
DATA: text type string.

text = system_date.
response->set_text( text ).

Done

Log on to answer question

Step 6: Test the service again

Save (Ctrl+S) and activate (Ctrl+F3) your class.
Test your service by clicking the URL link again. This time, the preview should display something like this:

.
Image depicting step-6-system-date

Done

Log on to answer question

Step 7: Check code

View Full Instructions

Your code should look like this:

class ZCL_JP_TEST_HTTP definition
  public
  create public .

public section.

  interfaces IF_HTTP_SERVICE_EXTENSION .
protected section.
private section.
ENDCLASS.

CLASS ZCL_JP_TEST_HTTP IMPLEMENTATION.

  method IF_HTTP_SERVICE_EXTENSION~HANDLE_REQUEST.
      DATA(system_date) = CL_ABAP_CONTEXT_INFO=>get_system_date( ).
      DATA: text type string.

      text = system_date.
      response->set_text( text ).
  endmethod.
ENDCLASS.

Done

Log on to answer question

Step 8: Create an inbound Communication Scenario

You will now create the artefacts you need to allow other systems to call your service compliantly. This involves some overhead for one consumer; however, the advantage is that you can add several consumer systems, or users (for example, with different authentication) pointing to the same HTTP service, wrapped in the same Communication Scenario.

First, create the Communication Scenario.

Select your package, then choose New > Other Repository Object… from the context menu.
Add the filter scen, then choose Communication Scenario, then choose Next.
Add a Name: Z_WRAP_HTTP_INBOUND_XXX and Description, choose a transport request, then choose Finish.

Your Communication Scenario appears.

Done

Log on to answer question

Step 9: Add the HTTP service

On the Inbound tab, choose Add….
IMPORTANT: Choose Browse. You cannot simply enter the name. Then add a filter, such as Z_HTTP, select your service, then choose Finish.
Your service appears. Choose Publish Locally.

Done

Log on to answer question

Step 10: Create Communication Arrangement

Open the dashboard for your system. You can find the URL for the dashboard by selecting your system (that is, ABAP Project in Project Explorer), then choosing Properties > ABAP Development from the context menu.
From Communication Management, choose Communication Arrangement. Then choose New.
Choose your scenario, Z_WRAP_HTTP_INBOUND_XXX from the drop-down list. Accept the default (identical) Arrangement name.

Done

Log on to answer question

Step 11: Create Communication System

From the Dashboard Home screen, choose Communication Systems.
Enter the name of your Communication Arrangement, then for Communication System, choose New.
Enter a System ID and Accept the default (identical) System name, then choose Create.
In Technical Data > General > Host Name, enter Dummy. Leave the other defaults and choose Save.

Done

Log on to answer question

Step 12: Create Communication User

Scroll down to Users for Inbound Communication, then create a new user by choosing the + icon.
Choose New User and the Authentication Method: User name and password.
Enter a name and description, then choose Propose password, then choose Create > OK > Save.

Done

Log on to answer question

Step 13: Save Communication Arrangement

Done

Log on to answer question

Step 14: Test yourself

What is the correct syntax to Implement the method `IF_HTTP_SERVICE_EXTENSION~HANDLE_REQUEST`
so that it returns the current user name (`UNAME`), not the system date. Choose only one option. DATA() = CL_ABAP_CONTEXT_INFO=>get_user_formatted_name( user_name ) DATA(user_name) = CL_ABAP_CONTEXT_INFO->get_user_formatted_name( ) DATA(user_name) = CL_ABAP_CONTEXT_INFO=>get_user_formatted_name( ).

Next Steps

Navigate tutorial steps

Step 1: Create an HTTP service
Step 2: Implement the handler class
Step 3: Save and activate
Step 4: Test the service
Step 5: Add system date to the method
Step 6: Test the service again
Step 7: Check code
Step 8: Create an inbound Communication Scenario
Step 9: Add the HTTP service
Step 10: Create Communication Arrangement
Step 11: Create Communication System
Step 12: Create Communication User
Step 13: Save Communication Arrangement
Step 14: Test yourself
Back to Top

QR Code

Create an HTTP Service

Create an HTTP Service

You will learn

Next Steps

Call me now