API for Partner Central Channel API

ABAP Package	/AWS1/API_PTC
ABAP SDK "TLA"	PTC
ABAP Interface	/AWS1/IF_PTC

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Partner Central Channel API is PTC. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the PartnerCentral Channel module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

AWS Partner Central Channel service for managing partner relationships, handshakes, and program management accounts.

Using the SDK

In your code, create a client using the SDK module for Partner Central Channel API, which is created with factory method /AWS1/CL_PTC_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_ptc)       = /aws1/cl_ptc_factory=>create( go_session ).

Your variable go_ptc is an instance of /AWS1/IF_PTC, and all of the operations in the Partner Central Channel API service are accessed by calling methods in /AWS1/IF_PTC.

API Operations

For an overview of ABAP method calls corresponding to API operations in Partner Central Channel API, see the Operation List.

Factory Method

/AWS1/CL_PTC_FACTORY=>create( )

Creates an object of type /AWS1/IF_PTC.

IMPORTING

Optional arguments:

iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

RETURNING

oo_client TYPE REF TO /aws1/if_ptc /AWS1/IF_PTC

/AWS1/IF_PTC represents the ABAP client for the PartnerCentral Channel service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_ptc)->get_config( ).

lo_config is a variable of type /AWS1/CL_PTC_CONFIG. See the documentation for /AWS1/CL_PTC_CONFIG for details on the settings that can be configured.

Paginators

Paginators for Partner Central Channel API can be created via get_paginator() which returns a paginator object of type /AWS1/IF_PTC_PAGINATOR. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next() and get_next() methods.

Details about the paginator methods available for service Partner Central Channel API can be found in interface /AWS1/IF_PTC_PAGINATOR.