Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Commit

Permalink
Generated API docs for version 3.43.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@IngenicoEPayments
IngenicoEPayments committed Oct 16, 2023
1 parent eaeb851 commit cea0af1
Show file tree
Hide file tree
Showing 480 changed files with 14,870 additions and 8,079 deletions.
99 changes: 37 additions & 62 deletions 3.x/README.html
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Ingenico Connect Python SDK &#8212; connect-sdk-python3 3.42.0 documentation</title>
<title>Ingenico Connect Python SDK &#8212; connect-sdk-python3 3.43.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=3a817518"></script>
<script src="_static/documentation_options.js?v=33718c35"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />

Expand All @@ -30,120 +30,95 @@
<div class="body" role="main">

<section id="ingenico-connect-python-sdk">
<h1>Ingenico Connect Python SDK<a class="headerlink" href="#ingenico-connect-python-sdk" title="Permalink to this heading"></a></h1>
<h1>Ingenico Connect Python SDK<a class="headerlink" href="#ingenico-connect-python-sdk" title="Link to this heading"></a></h1>
<section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading"></a></h2>
<p>The Python SDK helps you to communicate with the <a class="reference external" href="https://epayments.developer-ingenico.com/">Ingenico
Connect</a> Server API. Its
primary features are:</p>
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h2>
<p>The Python SDK helps you to communicate with the <a class="reference external" href="https://epayments.developer-ingenico.com/">Ingenico Connect</a> Server API. Its primary features are:</p>
<ul class="simple">
<li><p>convenient Python library for the API calls and responses</p>
<ul>
<li><p>marshalls Python request objects to HTTP requests</p></li>
<li><p>unmarshalls HTTP responses to Python response objects or Python
exceptions</p></li>
<li><p>unmarshalls HTTP responses to Python response objects or Python exceptions</p></li>
</ul>
</li>
<li><p>handling of all the details concerning authentication</p></li>
<li><p>handling of required meta data</p></li>
</ul>
<p>Its use is demonstrated by an example for each possible call. The
examples execute a call using the provided API keys.</p>
<p>See the <a class="reference external" href="https://epayments.developer-ingenico.com/documentation/sdk/server/python/">Ingenico Connect Developer
Hub</a>
for more information on how to use the SDK.</p>
<p>Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.</p>
<p>See the <a class="reference external" href="https://epayments.developer-ingenico.com/documentation/sdk/server/python/">Ingenico Connect Developer Hub</a> for more information on how to use the SDK.</p>
</section>
<section id="structure-of-this-repository">
<h2>Structure of this repository<a class="headerlink" href="#structure-of-this-repository" title="Permalink to this heading"></a></h2>
<h2>Structure of this repository<a class="headerlink" href="#structure-of-this-repository" title="Link to this heading"></a></h2>
<p>This repository consists out of four main components:</p>
<ol class="arabic simple">
<li><p>The source code of the SDK itself: <code class="docutils literal notranslate"><span class="pre">/ingenico/connect/sdk/</span></code></p></li>
<li><p>The source code of the SDK unit tests: <code class="docutils literal notranslate"><span class="pre">/tests/unit/</span></code></p></li>
<li><p>The source code of the SDK integration tests: <code class="docutils literal notranslate"><span class="pre">/tests/integration/</span></code></p></li>
<li><p>Usage examples: <code class="docutils literal notranslate"><span class="pre">/examples/</span></code></p></li>
</ol>
<p>Note that the source code of the unit tests and integration tests and
the examples can only be found on GitHub.</p>
<p>Note that the source code of the unit tests and integration tests and the examples can only be found on GitHub.</p>
</section>
<section id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
<p>Python 3.5 or higher is required. In addition, the following packages
are required:</p>
<h2>Requirements<a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<p>Python 3.5 or higher is required. In addition, the following packages are required:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://requests.readthedocs.io/">requests</a> 2.25.0 or higher</p></li>
<li><p><a class="reference external" href="https://toolbelt.readthedocs.io/">requests-toolbelt</a> 0.8.0 or
higher</p></li>
<li><p><a class="reference external" href="https://toolbelt.readthedocs.io/">requests-toolbelt</a> 0.8.0 or higher</p></li>
</ul>
<p>These packages will be installed automatically if the SDK is installed
manually or using pip following the below instructions.</p>
<p>These packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.</p>
</section>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h2>
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h2>
<p>To install the SDK using pip, execute the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">connect</span><span class="o">-</span><span class="n">sdk</span><span class="o">-</span><span class="n">python3</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>connect-sdk-python3
</pre></div>
</div>
<p>Alternatively, you can install the SDK from a source distribution file:</p>
<ol class="arabic">
<li><p>Download the latest version of the Python SDK from GitHub. Choose the
<code class="docutils literal notranslate"><span class="pre">connect-sdk-python3-x.y.z.zip</span></code> file from the
<a class="reference external" href="https://github.com/Ingenico-ePayments/connect-sdk-python3/releases">releases</a>
page, where <code class="docutils literal notranslate"><span class="pre">x.y.z</span></code> is the version number.</p></li>
<li><p>Execute the following command in the folder where the SDK was
downloaded to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">connect</span><span class="o">-</span><span class="n">sdk</span><span class="o">-</span><span class="n">python3</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">z</span><span class="o">.</span><span class="n">zip</span>
<li><p>Download the latest version of the Python SDK from GitHub. Choose the <code class="docutils literal notranslate"><span class="pre">connect-sdk-python3-x.y.z.zip</span></code> file from the <a class="reference external" href="https://github.com/Ingenico-ePayments/connect-sdk-python3/releases">releases</a> page, where <code class="docutils literal notranslate"><span class="pre">x.y.z</span></code> is the version number.</p></li>
<li><p>Execute the following command in the folder where the SDK was downloaded to:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>connect-sdk-python3-x.y.z.zip
</pre></div>
</div>
</li>
</ol>
</section>
<section id="uninstalling">
<h2>Uninstalling<a class="headerlink" href="#uninstalling" title="Permalink to this heading"></a></h2>
<p>After the Python SDK has been installed, it can be uninstalled using the
following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">uninstall</span> <span class="n">connect</span><span class="o">-</span><span class="n">sdk</span><span class="o">-</span><span class="n">python3</span>
<h2>Uninstalling<a class="headerlink" href="#uninstalling" title="Link to this heading"></a></h2>
<p>After the Python SDK has been installed, it can be uninstalled using the following command:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>uninstall<span class="w"> </span>connect-sdk-python3
</pre></div>
</div>
<p>The required packages can be uninstalled in the same way.</p>
</section>
<section id="running-tests">
<h2>Running tests<a class="headerlink" href="#running-tests" title="Permalink to this heading"></a></h2>
<p>There are two types of tests: unit tests and integration tests. The unit
tests will work out-of-the-box; for the integration tests some
configuration is required. First, some environment variables need to be
set:</p>
<h2>Running tests<a class="headerlink" href="#running-tests" title="Link to this heading"></a></h2>
<p>There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required.
First, some environment variables need to be set:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">connect.api.apiKeyId</span></code> for the API key id to use. This can be
retrieved from the Configuration Center.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">connect.api.secretApiKey</span></code> for the secret API key to use. This can
be retrieved from the Configuration Center.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">connect.api.apiKeyId</span></code> for the API key id to use. This can be retrieved from the Configuration Center.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">connect.api.secretApiKey</span></code> for the secret API key to use. This can be retrieved from the Configuration Center.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">connect.api.merchantId</span></code> for your merchant ID.</p></li>
</ul>
<p>In addition, to run the proxy integration tests, the proxy URI, username
and password should be set in the
<code class="docutils literal notranslate"><span class="pre">tests/resources/configuration.proxy.ini</span></code> file.</p>
<p>In order to run the unit and integration tests, the
<a class="reference external" href="https://pypi.python.org/pypi/mock">mock</a> backport and
<a class="reference external" href="https://pypi.python.org/pypi/mockito">mockito</a> are required. These
can be installed using the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">mock</span> <span class="n">mockito</span>
<p>In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the <code class="docutils literal notranslate"><span class="pre">tests/resources/configuration.proxy.ini</span></code> file.</p>
<p>In order to run the unit and integration tests, the <a class="reference external" href="https://pypi.python.org/pypi/mock">mock</a> backport and <a class="reference external" href="https://pypi.python.org/pypi/mockito">mockito</a> are required. These can be installed using the following command:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>mock<span class="w"> </span>mockito
</pre></div>
</div>
<p>The following commands can now be executed from the <code class="docutils literal notranslate"><span class="pre">tests</span></code> directory
to execute the tests:</p>
<p>The following commands can now be executed from the <code class="docutils literal notranslate"><span class="pre">tests</span></code> directory to execute the tests:</p>
<ul>
<li><p>Unit tests:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_unit_tests</span><span class="o">.</span><span class="n">py</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>run_unit_tests.py
</pre></div>
</div>
</li>
<li><p>Integration tests:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_integration_tests</span><span class="o">.</span><span class="n">py</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>run_integration_tests.py
</pre></div>
</div>
</li>
<li><p>Both unit and integration tests:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_all_tests</span><span class="o">.</span><span class="n">py</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>run_all_tests.py
</pre></div>
</div>
</li>
Expand Down Expand Up @@ -202,7 +177,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;Copyright (c) 2016 Global Collect Services B.V..

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

|
Expand Down
Loading

0 comments on commit cea0af1

Please sign in to comment.