API for Payment Cryptography Control Plane¶

ABAP Package	`/AWS1/API_PCY_IMPL`
ABAP SDK "TLA"	`PCY`
ABAP Interface	`/AWS1/IF_PCY`

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 Payment Cryptography Control Plane is PCY. 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 Payment Cryptography 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¶

Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.

To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.

All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests.

Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.

Using the SDK¶

In your code, create a client using the SDK module for Payment Cryptography Control Plane, which is created with factory method /AWS1/CL_PCY_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_pcy)       = /aws1/cl_pcy_factory=>create( go_session ).

Your variable go_pcy is an instance of /AWS1/IF_PCY, and all of the operations in the Payment Cryptography Control Plane service are accessed by calling methods in /AWS1/IF_PCY.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Payment Cryptography Control Plane, see the Operation List.

Factory Method¶

`/AWS1/CL_PCY_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_PCY.

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_PCY` `/AWS1/IF_PCY`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Payment Cryptography Control Plane can be created via get_paginator() which returns a paginator object of type /AWS1/IF_PCY_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 Payment Cryptography Control Plane can be found in interface /AWS1/IF_PCY_PAGINATOR.