{
    "info": {
        "author": "MessageMedia Developers",
        "author_email": "developers@messagemedia.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# MessageMedia Signature Key Management Python SDK\n[![Travis Build Status](https://api.travis-ci.org/messagemedia/signingkeys-python-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/signingkeys-python-sdk)\n[![PyPI version](https://badge.fury.io/py/messagemedia-signingkeys-sdk.svg)](https://badge.fury.io/py/messagemedia-signingkeys-sdk)\n\nThe MessageMedia Signature Key API provides a number of endpoints for managing key used to sign each unique request to ensure security and the requests can't (easily) be spoofed. This is similar to using HMAC in your outbound messaging (rather than HTTP Basic).\n\n## \u2b50\ufe0f Install via PIP\nRun the following command to install the SDK via pip:\n`pip install messagemedia-signingkeys-sdk`\n\n## \ud83c\udfac Get Started\nIt's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below.\n\n### \ud83d\ude80 Create a signature key\n```python\nfrom message_media_signing_keys.message_media_signing_keys_client import MessageMediaSigningKeysClient\n\n# Configuration parameters and credentials\nbasic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication\nbasic_auth_password = 'basic_auth_password' # The password to use with basic authentication\n\nclient = MessageMediaSigningKeysClient(basic_auth_user_name, basic_auth_password)\n\nsignature_key_management_controller = client.signature_key_management\n\nbody_value = \"{   \\\"digest\\\": \\\"SHA224\\\",   \\\"cipher\\\": \\\"RSA\\\" }\"\nbody = json.loads(body_value)\n\nresult = signature_key_management_controller.create_signature_key(body)\n\n```\n\n### \ud83d\udce5 Get signature key details\nYou can get a key_id by looking at the id of the signature key created from the response of the above example.\n```python\nfrom message_media_signing_keys.message_media_signing_keys_client import MessageMediaSigningKeysClient\n\n# Configuration parameters and credentials\nbasic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication\nbasic_auth_password = 'basic_auth_password' # The password to use with basic authentication\n\nclient = MessageMediaSigningKeysClient(basic_auth_user_name, basic_auth_password)\n\nsignature_key_management_controller = client.signature_key_management\n\nkey_id = 'key_id'\n\nresult = signature_key_management_controller.get_signature_key_detail(key_id)\n\n```\n\n### \ud83d\udce5 Get signature keys list\n```python\nfrom message_media_signing_keys.message_media_signing_keys_client import MessageMediaSigningKeysClient\n\n# Configuration parameters and credentials\nbasic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication\nbasic_auth_password = 'basic_auth_password' # The password to use with basic authentication\n\nclient = MessageMediaSigningKeysClient(basic_auth_user_name, basic_auth_password)\n\nsignature_key_management_controller = client.signature_key_management\n\nresult = signature_key_management_controller.get_signature_key_list()\n\n```\n\n### \u274c Delete signature key\nYou can get the key_id by looking at the ids of the signature keys returned from the response of the `Get signature keys list` example.\n```python\nfrom message_media_signing_keys.message_media_signing_keys_client import MessageMediaSigningKeysClient\n\n# Configuration parameters and credentials\nbasic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication\nbasic_auth_password = 'basic_auth_password' # The password to use with basic authentication\n\nclient = MessageMediaSigningKeysClient(basic_auth_user_name, basic_auth_password)\n\nsignature_key_management_controller = client.signature_key_management\n\nkey_id = 'key_id'\n\nsignature_key_management_controller.delete_signature_key(key_id)\n\n```\n\n### \u2611\ufe0f Enable a signature key\nYou can get the key_id by looking at the ids of the signature keys returned from the response of the `Get signature keys list` example.\n```python\nfrom message_media_signing_keys.message_media_signing_keys_client import MessageMediaSigningKeysClient\n\n# Configuration parameters and credentials\nbasic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication\nbasic_auth_password = 'basic_auth_password' # The password to use with basic authentication\n\nclient = MessageMediaSigningKeysClient(basic_auth_user_name, basic_auth_password)\n\nsignature_key_management_controller = client.signature_key_management\n\nbody = EnableSignatureKeyRequest({\n  \"key_id\": \"7ca628a8-08b0-4e42-aeb8-960b37049c31\"\n})\n\nresult = signature_key_management_controller.update_enable_signature_key(body)\n\n```\n\n### \ud83d\udce5 Get enabled signature key\n```python\nfrom message_media_signing_keys.message_media_signing_keys_client import MessageMediaSigningKeysClient\n\n# Configuration parameters and credentials\nbasic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication\nbasic_auth_password = 'basic_auth_password' # The password to use with basic authentication\n\nclient = MessageMediaSigningKeysClient(basic_auth_user_name, basic_auth_password)\n\nsignature_key_management_controller = client.signature_key_management\n\nresult = signature_key_management_controller.get_enabled_signature_key()\n\n```\n\n### \ud83d\udeab Disable an enabled signature key\n```python\nfrom message_media_signing_keys.message_media_signing_keys_client import MessageMediaSigningKeysClient\n\n# Configuration parameters and credentials\nbasic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication\nbasic_auth_password = 'basic_auth_password' # The password to use with basic authentication\n\nclient = MessageMediaSigningKeysClient(basic_auth_user_name, basic_auth_password)\n\nsignature_key_management_controller = client.signature_key_management\n\nsignature_key_management_controller.delete_disable_the_current_enabled_signature_key()\n\n```\n\n## \ud83d\udcd5 Documentation\nCheck out the [full API documentation](DOCUMENTATION.md) for more detailed information.\n\n## \ud83d\ude15 Need help?\nPlease contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)\n\n## \ud83d\udcc3 License\nApache License. See the [LICENSE](LICENSE) file.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://developers.messagemedia.com",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "messagemedia-signingkeys-sdk",
        "package_url": "https://pypi.org/project/messagemedia-signingkeys-sdk/",
        "platform": "",
        "project_url": "https://pypi.org/project/messagemedia-signingkeys-sdk/",
        "project_urls": {
            "Homepage": "https://developers.messagemedia.com"
        },
        "release_url": "https://pypi.org/project/messagemedia-signingkeys-sdk/1.1.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "The MessageMedia Signature Key API provides a number of endpoints  for managing key used to sign each unique request to ensure security  and the requests can't (easily) be spoofed. This is similar to using  HMAC in your outbound messaging (rather than HTTP Basic).",
        "version": "1.1.0"
    },
    "last_serial": 4031481,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f0a69e139fdb6ba7fc4b423d93a82115",
                    "sha256": "a6ae70206f104d95cf914be2d1dcc70bc8cfc5ce79b0e34a892041c0a8167acb"
                },
                "downloads": -1,
                "filename": "messagemedia_signingkeys_sdk-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "f0a69e139fdb6ba7fc4b423d93a82115",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21614,
                "upload_time": "2018-06-27T00:31:36",
                "url": "https://files.pythonhosted.org/packages/eb/8b/758a4cb922629f43033bc35b1a6757573c2707f1e3c46c09e52095cfa089/messagemedia_signingkeys_sdk-1.0.0.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "54403663095c8467cb1d574c800d3136",
                    "sha256": "8549a482083cc149ce306fc709dee142f4ff3af1fd4b428a327cab7faf9c44cd"
                },
                "downloads": -1,
                "filename": "messagemedia_signingkeys_sdk-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "54403663095c8467cb1d574c800d3136",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 23931,
                "upload_time": "2018-07-05T02:10:47",
                "url": "https://files.pythonhosted.org/packages/76/8f/8609646ff0c37bedec5e30cfeab1ac8a303522388c913f401b6ee9bfb165/messagemedia_signingkeys_sdk-1.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "54403663095c8467cb1d574c800d3136",
                "sha256": "8549a482083cc149ce306fc709dee142f4ff3af1fd4b428a327cab7faf9c44cd"
            },
            "downloads": -1,
            "filename": "messagemedia_signingkeys_sdk-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "54403663095c8467cb1d574c800d3136",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23931,
            "upload_time": "2018-07-05T02:10:47",
            "url": "https://files.pythonhosted.org/packages/76/8f/8609646ff0c37bedec5e30cfeab1ac8a303522388c913f401b6ee9bfb165/messagemedia_signingkeys_sdk-1.1.0.tar.gz"
        }
    ]
}