Skip to content

Latest commit

 

History

History
167 lines (113 loc) · 6.64 KB

README.md

File metadata and controls

167 lines (113 loc) · 6.64 KB

.NET Standard Authentication SDK

This project provides a simple C# helper library that simplifies authentication to the CyberSource REST API.

Requirements

  • .NET Standard 2.1

  • A CyberSource merchant account (see Registration & Configuration section below)

Dependencies

  • jose-jwt 2.5.0 : Generating Json Web Token
  • NLog 4.7.4 : Logging

Usage

The Authentication SDK works for POST, GET, PUT and DELETE requests. It supports two authentication mechanisms, viz. HTTP Signature and JSON Web Token (JWT).

Configuration

To set your API credentials for an API request, configure the following information in App.Config file inside the <MerchantConfig></MerchantConfig> tags:

HTTP Signature Authentication

Configure the following information in App.Config file

  • Authentication Type: Merchant should enter "HTTP_Signature" for HTTP authentication mechanism.

  • Merchant ID: Merchant will provide the Merchant ID, which was received from EBC portal.

  • MerchantSecretKey: Merchant will provide the Secret Key value, which was generated on EBC portal.

  • MerchantKeyId: Merchant will provide the Key ID value, which was generated on EBC portal.

  • Enable Log: To start the log entry, this value should be set to true, else false.

  • LogDirectory: Merchant will provide directory path where logs will be created.

  • LogMaximumSize: Merchant will provide size value for log file.

  • LogFilename: Merchant will provide log file name.

  • Use Meta Key: Set to false

   authenticationType  = http_Signature
   merchantID          = <merchantID>
   runEnvironment      = CyberSource.Environment.SANDBOX
   merchantKeyId       = <merchantKeyId>
   merchantsecretKey   = <merchantsecretKey>
   enableLog           = true
   logDirectory        = <logDirectory>
   logMaximumSize      = <size>
   logFilename         = <logFilename>
   useMetaKey          = false

JWT Authentication

Configure the following information in the App.Config file

  • Authentication Type: Merchant should enter "JWT" for JWT authentication mechanism.

  • Merchant ID: Merchant will provide the Merchant ID, which was received from EBC portal.

  • keyAlias: Alias of the Merchant ID, to be used while generating the JWT token.

  • keyPassword: Alias of the Merchant password, to be used while generating the JWT token.

  • keyfilepath: Path of the folder where the .P12 file is placed. This file can be generated from the EBC portal.

  • Keys Directory: path of the directory, where keys are placed.

  • Enable Log: To start the log entry, this value should be set to true, else false.

  • LogDirectory: Merchant will provide directory path where logs will be created.

  • LogMaximumSize: Merchant will provide size value for log file.

  • LogFilename: Merchant will provide log file name.

  • Use Meta Key: Set to false

   authenticationType  = Jwt
   merchantID          = <merchantID>
   runEnvironment      = CyberSource.Environment.SANDBOX
   keyAlias            = <keyAlias>
   keyPassword         = <keyPassword>
   keyFileName         = <keyFileName>
   keysDirectory       = <keysDirectory>
   enableLog           = true
   logDirectory        = <logDirectory>
   logMaximumSize      = <size>
   logFilename         = <logFilename>
   useMetaKey          = false

For using MetaKey

MetaKey can be used for HTTP Signature and JWT authentication Configure the following information in App.config file

For HTTP Signature Authentication -

  • Authentication Type: Merchant should enter "HTTP".
  • Merchant ID: Merchant will provide the child merchant ID under the Portfolio ID, which has taken from EBC portal.
  • MerchantSecretKey: Merchant will provide the secret Meta Key value, which has taken from EBC portal.
  • MerchantKeyId: Merchant will provide the Meta Key ID value, which has taken from EBC portal.
  • PortfolioId: Merchant will provide the Portfolio ID, taken from EBC portal.
  • Use Meta Key: Set it to true to use Meta Key.
   authenticationType  = http_Signature
   merchantID          = <child merchantID>  
   merchantKeyId       = <MetaKey merchantKeyId>
   merchantsecretKey   = <Metakey merchantsecretKey>
   useMetaKey          = true
   portfolioID         = <Portfolio ID>

For JWT Authentication -

  • Authentication Type: Merchant should enter "JWT".
  • Merchant ID: Merchant will provide the child merchant ID under the Portfolio ID, which has taken from EBC portal.
  • keyAlias: Alias of the Merchant ID, to be used while generating the JWT token.
  • keyPassword: Alias of the Portfolio ID password, to be used while generating the JWT token.
  • keyfilepath: Path of the folder where the .P12 file is placed. This file has generated from the EBC portal.
  • Use Meta Key: Set it to true to use Meta Key.
   authenticationType  = Jwt
   merchantID          = <child merchantID>   
   keyAlias            = <keyAlias>
   keyPassword         = <keyPassword>
   keyFileName         = <keyFileName>
   keysDirectory       = <keysDirectory>
   useMetaKey          = true

Switching between the sandbox environment and the production environment

CyberSource maintains a complete sandbox environment for testing and development purposes. This sandbox environment is an exact duplicate of our production environment with the transaction authorization and settlement process simulated. By default, this SDK is configured to communicate with the sandbox environment. To switch to the production environment, set the appropriate environment constant, as shown in Sample Configuration file.

For example:

// For TESTING use
_configurationDictionary.Add("runEnvironment", "apitest.cybersource.com");

// For PRODUCTION use
// _configurationDictionary.Add("runEnvironment", "api.cybersource.com");

SDK Usage Examples and Sample Code

  • To get started using this SDK, it is highly recommended to download our sample code repository.

  • In that repository, we have comprehensive code samples for all common uses of our API.

  • Additionally, you can find details and examples of how our API is structured in our Developer Center API Reference.

The API Reference Guide provides examples of what information is needed for a particular request and how that information would be formatted. Using those examples, you can easily determine what methods would be necessary to include that information in a request using this SDK.

License

This repository is distributed under a proprietary license.