gopay 1.0.0

Configuration

 Available methods

SDK response? Has my call succeed?

SDK returns wrapped API response. Every method returns `gopay.http.response object </gopay/http.py>`__. Structure of json/__str__ should be same as in documentation. SDK throws no exception. Please create an issue if you catch one.

response = payments.create_payment({})
if response.has_succeed():
    print("hooray, API returned " + str(response))
    return response.json['gw_url'] # url for initiation of gateway
else:
    # errors format: https://doc.gopay.com/en/?shell#http-result-codes
    print("oops, API returned " + str(response.status_code) + ": " + str(response))

 Are required fields and allowed values validated?

No. API validates fields pretty extensively so there is no need to duplicate validation in SDK. It would only introduce new type of error. Or we would have to perfectly simulate API error messages. That’s why SDK just calls API which behavior is well documented in doc.gopay.com.

Initiation of the payment gateway

# create payment and pass url to template
response = payments.create_payment({})
if response.has_succeed():
    templateParameters = {
        'gatewayUrl': response.json['gw_url'],
        'embedJs': gopay.url_to_embedjs()
    }
    # render template

<form action="<%= $gatewayUrl %>" method="post" id="gopay-payment-button">
  <button name="pay" type="submit">Pay</button>
  <script type="text/javascript" src="<%= $embedJs %>"></script>
</form>

<form action="<%= $gatewayUrl %>" method="post">
  <button name="pay" type="submit">Pay</button>
</form>

Enums (Code lists)

Instead of hardcoding bank codes string you can use predefined enums. Check using enums in create-payment example

Cache access token

Access token expires after 30 minutes so it’s expensive to use new token for every request. Unfortunately it’s default behavior of `gopay.oauth2.InMemoryTokenCache </gopay/oauth2.py>`__. But you can implement your cache and store tokens in Memcache, Redis, files, … It’s up to you.

Your cache must implement template methods get_token and set_token. Be aware that there are two scopes (TokenScope) and SDK can be used for different clients (clientId, isProductionMode). So client passed to methods is unique identifier (string) that is built for current environment. Below you can see example implementation of caching tokens in memory:

# register cache in optional service configuration
payments = gopay.payments(
    {}, # your config
    {'cache': MyCache()}
)

class MyCache:
    def __init__(self):
        self.tokens = {}

    def get_token(self, client):
        return self.tokens.get(client) # return None if token not exists

    def set_token(self, client, token):
        self.tokens[client] = token

Log HTTP communication

You can log every request and response from communication with API. Check available loggers below. Or you can implement your own logger, just implement function that takes two arguments: `gopay.http.request </gopay/http.py>`__ and `gopay.http.response </gopay/http.py>`__.

# register logger in optional service configuration
payments = gopay.payments(
    {}, # your config
    {'logger': my_logger}
)

def my_logger(request, response):
    print(vars(request))
    print(vars(response))