Skip to content

Latest commit

 

History

History
116 lines (76 loc) · 6 KB

RSASignaturesApi.md

File metadata and controls

116 lines (76 loc) · 6 KB
Raw

Zuora::RSASignaturesApi

All URIs are relative to https://rest.zuora.com

Method HTTP request Description
post_decrypt_rsa_signatures POST /v1/rsa-signatures/decrypt Decrypt RSA signature
post_rsa_signatures POST /v1/rsa-signatures Generate RSA signature

post_decrypt_rsa_signatures

POSTDecryptResponseType post_decrypt_rsa_signatures(request, opts)

Decrypt RSA signature

The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. You use rsa_signatures to generate the required digital signature and token for a Payment Pages 2.0 form, and then you use the decrypt REST service to decrypt the signature to validate the signature and key. This REST service should be used only when you implement Payment Pages 2.0.

Example

# load the gem
require 'zuora'

api_instance = Zuora::RSASignaturesApi.new

request = Zuora::POSTDecryptionType.new # POSTDecryptionType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Decrypt RSA signature
  result = api_instance.post_decrypt_rsa_signatures(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling RSASignaturesApi->post_decrypt_rsa_signatures: #{e}"
end

Parameters

Name Type Description Notes
request POSTDecryptionType
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

POSTDecryptResponseType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

post_rsa_signatures

POSTRSASignatureResponseType post_rsa_signatures(request, opts)

Generate RSA signature

The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. The POST rsa_signatures call generates and returns the required digital signature and token for a Payment Pages 2.0 form. You need to pass the generated signature to your client for it to access Payment Pages 2.0. This REST service should be used only when you implement Payment Pages 2.0.

Example

# load the gem
require 'zuora'

api_instance = Zuora::RSASignaturesApi.new

request = Zuora::POSTRSASignatureType.new # POSTRSASignatureType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Generate RSA signature
  result = api_instance.post_rsa_signatures(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling RSASignaturesApi->post_rsa_signatures: #{e}"
end

Parameters

Name Type Description Notes
request POSTRSASignatureType
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

POSTRSASignatureResponseType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8