pdstools.pega_io.API

Functions

_read_client_credential_file(credential_file)

get_url(credential_file)

Returns the URL of the Infinity instance in the credential file

get_token(credential_file[, verify])

Get API credentials to a Pega Platform instance.

Module Contents

_read_client_credential_file(credential_file: os.PathLike)
Parameters:

credential_file (os.PathLike)

get_url(credential_file: os.PathLike)

Returns the URL of the Infinity instance in the credential file

Parameters:

credential_file (os.PathLike)

get_token(credential_file: os.PathLike, verify: bool = True)

Get API credentials to a Pega Platform instance.

After setting up OAuth2 authentication in Dev Studio, you should be able to download a credential file. Simply point this method to that file, and it’ll read the relevant properties and give you your access token.

Parameters:

  • credentialFile (str) – The credential file downloaded after setting up OAuth in a Pega system

  • verify (bool, default = True) – Whether to only allow safe SSL requests. In case you’re connecting to an unsecured API endpoint, you need to explicitly set verify to False, otherwise Python will yell at you.

  • credential_file (os.PathLike)