| Name | card-management-sdk JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes. |
| upload_time | 2024-12-12 08:23:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
shell
card management
apimatic
sdks
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Getting Started with Shell Card Management APIs
## Introduction
The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication.
The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes.
All resources are located in the Shell Card Platform. The Shell Card Platform is the overall platform that encompasses all the internal Shell systems used to manage resources.
The internal workings of the platform are not important when interacting with the API. However, it is worth noting that the platform uses a microservice architecture to communicate with various backend systems and some API calls are processed asynchronously.
All endpoints use the `POST` verb for retrieving, updating, creating and deleting resources in the Shell Card Platform. The endpoints that retrieve resources from the Shell Card Platform allow flexible search parameters in the API request body.
Go to the Shell Developer Portal: [https://developer.shell.com](https://developer.shell.com)
## Install the Package
The package is compatible with Python versions `3 >=3.7, <= 3.11`.
Install the package from PyPi using the following pip command:
```bash
pip install card-management-sdk==1.3.0
```
You can also view the package at:
https://pypi.python.org/pypi/card-management-sdk/1.3.0
## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SIT`** |
| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
| `bearer_token_credentials` | [`BearerTokenCredentials`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows:
```python
client = ShellcardmanagementapisClient(
basic_auth_credentials=BasicAuthCredentials(
username='Username',
password='Password'
),
bearer_token_credentials=BearerTokenCredentials(
o_auth_client_id='OAuthClientId',
o_auth_client_secret='OAuthClientSecret'
),
environment=Environment.SIT
)
```
## Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
### Fields
| Name | Description |
| --- | --- |
| SIT | **Default** |
| Production | - |
## Authorization
This API uses the following authentication schemes.
* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/basic-authentication.md)
* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/oauth-2-client-credentials-grant.md)
## List of APIs
* [Customer](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/controllers/customer.md)
* [Restriction](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/controllers/restriction.md)
* [Card](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/controllers/card.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "card-management-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Shell, Card Management, APIMatic, SDKs",
"author": null,
"author_email": "developer sdksio <developer+sdksio@apimatic.io>",
"download_url": "https://files.pythonhosted.org/packages/b6/81/e8cfc40ff995943fc79bb1c82dd5b67519e2650368bbe4cab8c542602fec/card_management_sdk-1.3.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Shell Card Management APIs\n\n## Introduction\n\nThe Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication.\nThe API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes. \nAll resources are located in the Shell Card Platform. The Shell Card Platform is the overall platform that encompasses all the internal Shell systems used to manage resources.\nThe internal workings of the platform are not important when interacting with the API. However, it is worth noting that the platform uses a microservice architecture to communicate with various backend systems and some API calls are processed asynchronously.\nAll endpoints use the `POST` verb for retrieving, updating, creating and deleting resources in the Shell Card Platform. The endpoints that retrieve resources from the Shell Card Platform allow flexible search parameters in the API request body.\n\nGo to the Shell Developer Portal: [https://developer.shell.com](https://developer.shell.com)\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```bash\npip install card-management-sdk==1.3.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/card-management-sdk/1.3.0\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SIT`** |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |\n| `bearer_token_credentials` | [`BearerTokenCredentials`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |\n\nThe API client can be initialized as follows:\n\n```python\nclient = ShellcardmanagementapisClient(\n basic_auth_credentials=BasicAuthCredentials(\n username='Username',\n password='Password'\n ),\n bearer_token_credentials=BearerTokenCredentials(\n o_auth_client_id='OAuthClientId',\n o_auth_client_secret='OAuthClientSecret'\n ),\n environment=Environment.SIT\n)\n```\n\n## Environments\n\nThe SDK can be configured to use a different environment for making API calls. Available environments are:\n\n### Fields\n\n| Name | Description |\n| --- | --- |\n| SIT | **Default** |\n| Production | - |\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/basic-authentication.md)\n* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/auth/oauth-2-client-credentials-grant.md)\n\n## List of APIs\n\n* [Customer](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/controllers/customer.md)\n* [Restriction](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/controllers/restriction.md)\n* [Card](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/controllers/card.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/card-management-python-sdk/tree/1.3.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes.",
"version": "1.3.0",
"project_urls": {
"Documentation": "https://developer.shell.com/product-catalog/shell-card-management-advanced/sdk"
},
"split_keywords": [
"shell",
" card management",
" apimatic",
" sdks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f598c410e0e0bb1006c49ddce759a9e5721b0fe202d50d7af0dda7062f931b81",
"md5": "25727efa8226b18d1e1b4a6c0c68bfbd",
"sha256": "12c82da0cdfd073a87f1beffc493c1d2fe7df75aef517f4be818539b75231f6d"
},
"downloads": -1,
"filename": "card_management_sdk-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "25727efa8226b18d1e1b4a6c0c68bfbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 398076,
"upload_time": "2024-12-12T08:23:33",
"upload_time_iso_8601": "2024-12-12T08:23:33.660136Z",
"url": "https://files.pythonhosted.org/packages/f5/98/c410e0e0bb1006c49ddce759a9e5721b0fe202d50d7af0dda7062f931b81/card_management_sdk-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b681e8cfc40ff995943fc79bb1c82dd5b67519e2650368bbe4cab8c542602fec",
"md5": "bfc597e5b33880ceaf3863857003d311",
"sha256": "a1fdedec7d7b49cccac2a978f1b3deaef967ebdbc92730cf3b7b3c7ef6585caa"
},
"downloads": -1,
"filename": "card_management_sdk-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "bfc597e5b33880ceaf3863857003d311",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 193052,
"upload_time": "2024-12-12T08:23:36",
"upload_time_iso_8601": "2024-12-12T08:23:36.070035Z",
"url": "https://files.pythonhosted.org/packages/b6/81/e8cfc40ff995943fc79bb1c82dd5b67519e2650368bbe4cab8c542602fec/card_management_sdk-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 08:23:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "card-management-sdk"
}
