Skip to Content

Call an External API in SAP ABAP Environment

Requires Customer/Partner License
Point to an external API SAP BTP Environment and display its output in the console.
You will learn
  • How to create a new destination in SAP Cloud cockpit
  • How to call an external API from inside an ABAP class by pointing to this destination
julieplummer20Julie PlummerNovember 8, 2021
Created by
julieplummer20
September 13, 2018
Contributors
julieplummer20

Prerequisites

You will create a new destination service instance, specifying the URL for an external API, user/password, and authentication.
You will then create a class that calls the API and displays the output from it in the console.
This enables you to avoid hard-coding the URL of the external API in your ABAP class.

Throughout this tutorial, objects name include the suffix XXX. Always replace this with your group number or initials.

  • Step 1

    You will now create a destination in the ABAP Environment. This must be created at subaccount (not Space) level.

    1. In the SAP Cloud Platform cockpit of your Cloud Foundry subaccount, navigate to your subaccount.
    step1a-subaccount
    1. Choose Destinations, then choose New Destinations.

      step1a-cf-cockpit-new-destination
    2. Enter the following values and choose Save:

      Field Name Value
      Name e.g. Z_STREETMAP_XXX as here
      Type HTTP
      Description Can be anything, here Streetmap
      URL https://www.openstreetmap.org/#map=18/49.29271/8.64401 (In your browser, this would display Walldorf, Germany)
      Proxy Type Internet
      Authentication NoAuthentication
      step2b-destination-streetmap
    3. Choose Check Connection. You should get the following response.

    step1c-check-connection-200
  • Step 2
    1. In ABAP Development Tools (ADT), select the ABAP Cloud Project and choose New > ABAP Package.

    2. Enter the following and choose Next:

      • Name = Z_EXTERNAL_API_XXX
      • Description = Call external API
      • Package type = Development
      Image depicting step1a-create-package
    3. Choose Create new transport request, enter a description, such as “External API”, then choose Finish.

      step1c-new-transport-request
  • Step 3

    Now, you will create an ABAP class that will call your destination, and which you can run in the console.

    1. In the ABAP Development Tools (ADT), in the Package Explorer, select your package and choose New > ABAP Class from the context menu.

      Image depicting step-4a-create-class
    2. Enter a name and description for your class and choose Next. Remember to change XXX to your group number.

      Image depicting step-4b-name-class
    3. Choose or create a transport request, then choose Finish.

      Image depicting step-4c-class-transport-request

    The class is displayed in a new editor.

    Image depicting step-4d-class-editor
  • Step 4

    Add the following interfaces statement to the public section:

    ABAP
    Copy
    PUBLIC SECTION.
      INTERFACES if_oo_adt_classrun.
    PRIVATE SECTION.
    

    This enables you to run the class in the console.

  • Step 5

    To be able to access the external service, you must:
    - maintain a cloud destination for the remote system
    - create an HTTP client
    - send an HTTP request
    - output the response in the ABAP console
    - wrap the code in an exception

    Copy the following code. Replace the xxx of i_name with your group number:

    ABAP
    Copy
    METHOD if_oo_adt_classrun~main.
        TRY.
            DATA(lo_destination) = cl_http_destination_provider=>create_by_cloud_destination(
              i_name                  = 'Z_STREETMAP_XXX'
              i_authn_mode = if_a4c_cp_service=>service_specific ).
    
            DATA(lo_http_client) = cl_web_http_client_manager=>create_by_http_destination( i_destination = lo_destination ).
            DATA(lo_request) = lo_http_client->get_http_request( ).
    
            DATA(lo_response) = lo_http_client->execute( i_method = if_web_http_client=>get ).
              out->write( lo_response->get_text( ) ).
    
          CATCH cx_root INTO DATA(lx_exception).
            out->write( lx_exception->get_text( ) ).
        ENDTRY.
      ENDMETHOD.
    
    
  • Step 6
    1. Check your syntax (Ctrl+F2).
    2. Save (Ctrl+S) and activate (Ctrl+F3) your class.
  • Step 7

    Run your class in the console (F9).

    The output should look something like this:
    .

    Image depicting step-9-console

  • Step 8

    Which of the following is code snippets is correct? Choose all that apply.

Back to top