API for Partner Central Selling API¶
ABAP Package | /AWS1/API_PTS_IMPL |
---|---|
ABAP SDK "TLA" | PTS |
ABAP Interface | /AWS1/IF_PTS |
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 Selling API is PTS
.
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 Selling 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 API for Selling Reference Guide
This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities.
The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.
Features offered by AWS Partner Central API
-
Opportunity management: Manages coselling opportunities through API actions such as
CreateOpportunity
,UpdateOpportunity
,ListOpportunities
,GetOpportunity
, andAssignOpportunity
. -
AWS referral management: Manages referrals shared by AWS using actions such as
ListEngagementInvitations
,GetEngagementInvitation
,StartEngagementByAcceptingInvitation
, andRejectEngagementInvitation
. -
Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions
AssociateOpportunity
, andDisassociateOpportunity
. -
View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the
GetAWSOpportunitySummary
action. -
List solutions: Provides list APIs for listing partner offers using
ListSolutions
. -
Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created.
Using the SDK¶
In your code, create a client using the SDK module for Partner Central Selling API, which is created with
factory method /AWS1/CL_PTS_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_pts) = /aws1/cl_pts_factory=>create( go_session ).
Your variable go_pts
is an instance of /AWS1/IF_PTS
,
and all of the operations
in the Partner Central Selling API service are accessed by calling methods in /AWS1/IF_PTS
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Partner Central Selling API, see the Operation List.
Factory Method¶
/AWS1/CL_PTS_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_PTS
.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL
TYPE /AWS1/RT_PROTOCOL
/AWS1/RT_PROTOCOL
¶
IO_SESSION
TYPE REF TO /AWS1/CL_RT_SESSION_BASE
/AWS1/CL_RT_SESSION_BASE
¶
IV_REGION
TYPE /AWS1/RT_REGION_ID
/AWS1/RT_REGION_ID
¶
IV_CUSTOM_ENDPOINT
TYPE /AWS1/RT_ENDPOINT
/AWS1/RT_ENDPOINT
¶
RETURNING¶
OO_CLIENT
TYPE REF TO /AWS1/IF_PTS
/AWS1/IF_PTS
¶
/AWS1/IF_PTS
represents the ABAP client for the PartnerCentral Selling service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_pts)->get_config( ).
lo_config
is a variable of type /AWS1/CL_PTS_CONFIG
. See the documentation for /AWS1/CL_PTS_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Partner Central Selling API can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_PTS_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 Selling API can be found in interface /AWS1/IF_PTS_PAGINATOR
.