# Miva Merchant API SDK for Python (3.x)
This python library wraps the Miva Merchant JSON API introduced in
Miva Merchant 9.12. It allows you to quickly integrate your python
applications with a Miva Merchant store to fetch, create, and update
store data.
For api documentation visit [https://docs.miva.com/json-api](https://docs.miva.com/json-api).
# Requirements
- Miva Merchant 10.00+
- Python 3.x
**For Miva Merchant 9.x, use the 1.x release**
# Installation via pip
To install the SDK simply add it to your project with pip:
pip install merchantapi
*Note: On some operating systems the `pip` program may be named `pip3`*
# Adding as a dependency in your packages
You can also add it to your project's `requirements.txt` file:
merchantapi>=2.6.0
Then install
pip install -r requirements.txt
*Note: On some operating systems the `pip` program may be named `pip3`*
# Getting Started
For usage see the examples provided in the `examples/` directory.
# SSH Private Key Authentication
## Compatible Private Key Formats
- OpenSSH PEM
- PKCS#1 PEM
- PKCS#8 PEM
When specifying the key to use within the `SSHClient` or `SSHPrivateKeyAuthenticator`, specify the full path to your private key file.
## Create PKCS#1 from OpenSSH private key format
If your private key is in OpenSSH format (starts with `-----BEGIN OPENSSH PRIVATE KEY-----`) then you will need to convert it.
Create a copy of your key preserving permissions:
cp -p /path/to/private/key/id_rsa /path/to/private/key/id_rsa.pem
Convert in place to the proper format:
ssh-keygen -p -m PEM -f /path/to/private/key/id_rsa.pem
## Create PKCS#8 PEM from PKCS#1 PEM private key format
Converting the key with encryption:
openssl pkcs8 -in /path/to/private_key.pem -topk8 -out /path/to/private_key.pkcs8.pem
Converting the key without encryption:
openssl pkcs8 -in /path/to/private_key.pem -topk8 -nocrypt -out /path/to/private_key.pkcs8.pem
# SSH Agent Authentication
## Compatible Public Key Formats
Your public key must be in the OpenSSH Public Key format. The default public key format is usually the correct type if you generated your key using `ssh-keygen`.
See https://tools.ietf.org/html/rfc4253#section-6.6 for format.
A quick way to get the correct format if you have the key associated with your local SSH agent is to run the command `ssh-add -L` and copying the corresponding key.
# License
This library is licensed under the `Miva SDK License Agreement`.
See the `LICENSE` file for more information.
Raw data
{
"_id": null,
"home_page": "https://www.miva.com",
"name": "merchantapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "miva merchant json api sdk",
"author": "Miva, Inc.",
"author_email": "support@miva.com",
"download_url": "https://files.pythonhosted.org/packages/ad/c0/69ad974e4d8d79a9fe99d464518a2cfb4b1101bb14f09b463779cfdb7497/merchantapi-2.6.0.tar.gz",
"platform": null,
"description": "# Miva Merchant API SDK for Python (3.x)\n\nThis python library wraps the Miva Merchant JSON API introduced in \nMiva Merchant 9.12. It allows you to quickly integrate your python\napplications with a Miva Merchant store to fetch, create, and update\nstore data.\n\nFor api documentation visit [https://docs.miva.com/json-api](https://docs.miva.com/json-api).\n\n# Requirements\n\n- Miva Merchant 10.00+\n- Python 3.x\n\n**For Miva Merchant 9.x, use the 1.x release**\n\n# Installation via pip\n\nTo install the SDK simply add it to your project with pip:\n\n pip install merchantapi\n\n*Note: On some operating systems the `pip` program may be named `pip3`*\n\n# Adding as a dependency in your packages\n\nYou can also add it to your project's `requirements.txt` file:\n\n merchantapi>=2.6.0\n\nThen install\n\n pip install -r requirements.txt\n\n*Note: On some operating systems the `pip` program may be named `pip3`*\n\n# Getting Started\n\nFor usage see the examples provided in the `examples/` directory. \n\n# SSH Private Key Authentication\n\n## Compatible Private Key Formats\n\n- OpenSSH PEM\n- PKCS#1 PEM\n- PKCS#8 PEM\n\nWhen specifying the key to use within the `SSHClient` or `SSHPrivateKeyAuthenticator`, specify the full path to your private key file.\n\n## Create PKCS#1 from OpenSSH private key format\n\nIf your private key is in OpenSSH format (starts with `-----BEGIN OPENSSH PRIVATE KEY-----`) then you will need to convert it.\n\nCreate a copy of your key preserving permissions:\n\n cp -p /path/to/private/key/id_rsa /path/to/private/key/id_rsa.pem\n\nConvert in place to the proper format:\n\n ssh-keygen -p -m PEM -f /path/to/private/key/id_rsa.pem\n\n## Create PKCS#8 PEM from PKCS#1 PEM private key format\n\nConverting the key with encryption:\n\n openssl pkcs8 -in /path/to/private_key.pem -topk8 -out /path/to/private_key.pkcs8.pem\n\nConverting the key without encryption:\n\n openssl pkcs8 -in /path/to/private_key.pem -topk8 -nocrypt -out /path/to/private_key.pkcs8.pem\n\n# SSH Agent Authentication\n\n## Compatible Public Key Formats\n\nYour public key must be in the OpenSSH Public Key format. The default public key format is usually the correct type if you generated your key using `ssh-keygen`.\n\nSee https://tools.ietf.org/html/rfc4253#section-6.6 for format.\n\nA quick way to get the correct format if you have the key associated with your local SSH agent is to run the command `ssh-add -L` and copying the corresponding key.\n\n# License\n\nThis library is licensed under the `Miva SDK License Agreement`.\n\nSee the `LICENSE` file for more information.\n\n",
"bugtrack_url": null,
"license": "Miva SDK License Agreement",
"summary": "Miva Merchant JSON API SDK",
"version": "2.6.0",
"project_urls": {
"Homepage": "https://www.miva.com"
},
"split_keywords": [
"miva",
"merchant",
"json",
"api",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19d0d867a814973baa3cf59669f2e05557e6b0d95d2d6cb76becf8ad4b331207",
"md5": "46312a276343b1e6aad934737de7623f",
"sha256": "eb6e7b21f52a27dddb8ecf05ac9433dd9f9a0679279e5541b4284d3e549e3f4a"
},
"downloads": -1,
"filename": "merchantapi-2.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46312a276343b1e6aad934737de7623f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 776217,
"upload_time": "2024-04-03T18:15:54",
"upload_time_iso_8601": "2024-04-03T18:15:54.879258Z",
"url": "https://files.pythonhosted.org/packages/19/d0/d867a814973baa3cf59669f2e05557e6b0d95d2d6cb76becf8ad4b331207/merchantapi-2.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "adc069ad974e4d8d79a9fe99d464518a2cfb4b1101bb14f09b463779cfdb7497",
"md5": "416e49887a7b0b87d3682b0717a49e78",
"sha256": "dceabb2b14c902c44ad9d86c168c0e14aab1404eebb9934c63af4abe1bac9f01"
},
"downloads": -1,
"filename": "merchantapi-2.6.0.tar.gz",
"has_sig": false,
"md5_digest": "416e49887a7b0b87d3682b0717a49e78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 238467,
"upload_time": "2024-04-03T18:15:57",
"upload_time_iso_8601": "2024-04-03T18:15:57.158456Z",
"url": "https://files.pythonhosted.org/packages/ad/c0/69ad974e4d8d79a9fe99d464518a2cfb4b1101bb14f09b463779cfdb7497/merchantapi-2.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 18:15:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "merchantapi"
}
JSON