oauth1-signer-python
Table of Contents
Overview
Python library for generating a Mastercard API compliant OAuth signature.
Compatibility
Python 3.6+
References
Usage
Prerequisites
Before using this library, you will need to set up a project in the Mastercard Developers Portal.
As part of this set up, you'll receive credentials for your app:
- A consumer key (displayed on the Mastercard Developer Portal)
- A private request signing key (matching the public certificate displayed on the Mastercard Developer Portal)
Adding the Library to Your Project
pip install mastercard-oauth1-signer
Importing the Code
import oauth1.authenticationutils as authenticationutils
from oauth1.oauth import OAuth
Loading the Signing Key
A private key object can be created by calling the authenticationutils.load_signing_key method:
signing_key = authenticationutils.load_signing_key('
'
, '
'
)
Creating the OAuth Authorization Header
The method that does all the heavy lifting is OAuth.get_authorization_header. You can call into it directly and as long as you provide the correct parameters, it will return a string that you can add into your request's Authorization header.
POST example
uri = 'https://sandbox.api.mastercard.com/service'
payload = 'Hello world!'
authHeader = OAuth.get_authorization_header(uri, 'POST', payload, '
'
, signing_key)
GET example
uri = 'https://sandbox.api.mastercard.com/service'
authHeader = OAuth.get_authorization_header(uri, 'GET', None, '
'
, signing_key)
Use of authHeader with requests module (POST and GET example)
headerdict = {'Authorization' : authHeader}
requests.post(uri, headers=headerdict, data=payload)
requests.get(uri, headers=headerdict)
Signing HTTP Client Request Objects
Alternatively, you can use helper classes for some of the commonly used HTTP clients.
These classes will modify the provided request object in-place and will add the correct Authorization header. Once instantiated with a consumer key and private key, these objects can be reused.
Usage briefly described below, but you can also refer to the test project for examples.
Requests: HTTP for Humans™
You can sign request objects using the OAuthSigner class.
Usage:
uri = "https://sandbox.api.mastercard.com/service"
request = Request()
request.method = "POST"
# ...
signer = OAuthSigner(consumer_key, signing_key)
request = signer.sign_request(uri, request)
Usage of the oauth_ext
The requests library supports custom authentication extensions, with which the procedure of creating and calling such requests can simplify the process of request signing. Please, see the examples below:
POST example
from oauth1.oauth_ext import OAuth1RSA
from oauth1.oauth_ext import HASH_SHA256
import requests
uri = 'https://sandbox.api.mastercard.com/service'
oauth = OAuth1RSA(consumer_key, signing_key)
header = {'Content-type' : 'application/json', 'Accept' : 'application/json'}
# Passing payload for data parameter as string
payload = '{"key" : "value"}'
request = requests.post(uri, data=payload, auth=oauth, headers=header)
# Passing payload for data parameter as Json object
payload = {'key' : 'value'}
request = requests.post(uri, data=json.dumps(payload), auth=oauth, headers=header)
# Passing payload for json parameter Json object
payload = {'key' : 'value'}
request = requests.post(uri, json=payload, auth=oauth, headers=header)
GET example
from oauth1.oauth_ext import OAuth1RSA
import requests
uri = 'https://sandbox.api.mastercard.com/service'
oauth = OAuth1RSA(consumer_key, signing_key)
# Operation for get call
request = requests.get(uri, auth=oauth)
Integrating with OpenAPI Generator API Client Libraries
OpenAPI Generator generates API client libraries from OpenAPI Specs. It provides generators and library templates for supporting multiple languages and frameworks.
This project provides you with classes you can use when configuring your API client. These classes will take care of adding the correct Authorization header before sending the request.
Generators currently supported:
python
OpenAPI Generator
Client libraries can be generated using the following command:
java -jar openapi-generator-cli.jar generate -i openapi-spec.yaml -g python -o out
See also:
Usage of the oauth1.signer_interceptor
import openapi_client
from oauth1.signer_interceptor import add_signer_layer
# ...
config = openapi_client.Configuration()
config.host = 'https://sandbox.api.mastercard.com'
client = openapi_client.ApiClient(config)
add_signer_layer(client, '
'
, '
'
, '
'
)
some_api = openapi_client.SomeApi(client)
result = some_api.do_something()
# ...
802 Feb 22, 2021
11 Dec 11, 2022
76 Jan 2, 2023
5 Oct 27, 2022
15 Dec 11, 2022
210 Dec 24, 2022
1 Dec 10, 2021
598 Jan 7, 2023
2.2k Dec 26, 2022
![Deprecation notice about urllib3[secure] Safe](https://avatars.githubusercontent.com/u/55334829?v=4)
18 Oct 05, 2022
1k Dec 22, 2022
1 Feb 15, 2022
52 Jan 03, 2023
42 Dec 06, 2022
363 Dec 24, 2022
336 Dec 31, 2022
15 Jul 22, 2022
1 Jan 13, 2022
12 Dec 16, 2022
6 Oct 03, 2022
7.8k Jan 02, 2023
1 Dec 27, 2021
7 Nov 20, 2022
2.5k Jan 01, 2023
1 Jan 24, 2022
347 Dec 18, 2022
253 Nov 14, 2022
6 Dec 12, 2021
56 Dec 08, 2022