class OpenapiClient::AuthenticationApi
Attributes
Public Class Methods
# File lib/openapi_client/api/authentication_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Generate an access token for user authentication. This is the access token generation call for authorizing subsequent financial transactions. A valid access token is required for web client requests. @param content_type [String] Content type. @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee. @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). @param access_token_request [AccessTokenRequest] Access token request @param [Hash] opts the optional parameters @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. @return [AccessTokenResponse]
# File lib/openapi_client/api/authentication_api.rb, line 32 def authentication_access_tokens_post(content_type, client_request_id, api_key, timestamp, access_token_request, opts = {}) data, _status_code, _headers = authentication_access_tokens_post_with_http_info(content_type, client_request_id, api_key, timestamp, access_token_request, opts) data end
Generate an access token for user authentication. This is the access token generation call for authorizing subsequent financial transactions. A valid access token is required for web client requests. @param content_type [String] Content type. @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee. @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). @param access_token_request [AccessTokenRequest] Access token request @param [Hash] opts the optional parameters @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. @return [Array<(AccessTokenResponse
, Integer, Hash)>] AccessTokenResponse
data, response status code and response headers
# File lib/openapi_client/api/authentication_api.rb, line 47 def authentication_access_tokens_post_with_http_info(content_type, client_request_id, api_key, timestamp, access_token_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AuthenticationApi.authentication_access_tokens_post ...' end # verify the required parameter 'content_type' is set if @api_client.config.client_side_validation && content_type.nil? fail ArgumentError, "Missing the required parameter 'content_type' when calling AuthenticationApi.authentication_access_tokens_post" end # verify enum value allowable_values = ["application/json"] if @api_client.config.client_side_validation && !allowable_values.include?(content_type) fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}" end # verify the required parameter 'client_request_id' is set if @api_client.config.client_side_validation && client_request_id.nil? fail ArgumentError, "Missing the required parameter 'client_request_id' when calling AuthenticationApi.authentication_access_tokens_post" end # verify the required parameter 'api_key' is set if @api_client.config.client_side_validation && api_key.nil? fail ArgumentError, "Missing the required parameter 'api_key' when calling AuthenticationApi.authentication_access_tokens_post" end # verify the required parameter 'timestamp' is set if @api_client.config.client_side_validation && timestamp.nil? fail ArgumentError, "Missing the required parameter 'timestamp' when calling AuthenticationApi.authentication_access_tokens_post" end # verify the required parameter 'access_token_request' is set if @api_client.config.client_side_validation && access_token_request.nil? fail ArgumentError, "Missing the required parameter 'access_token_request' when calling AuthenticationApi.authentication_access_tokens_post" end # resource path local_var_path = '/authentication/access-tokens' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' # header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # header_params[:'Content-Type'] = content_type header_params[:'Client-Request-Id'] = client_request_id header_params[:'Api-Key'] = api_key header_params[:'Timestamp'] = timestamp header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(access_token_request) # return_type return_type = opts[:return_type] || 'AccessTokenResponse' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: AuthenticationApi#authentication_access_tokens_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end