Skip to main content

SDK for Sweetspot Team to interact with backend APIs

Project description

Sweetspot Python SDK

This Python library helps Sweetspot developers interact with their backend APIs to modify shops, merchants, and consumers.

Installation

pip install sweetspot-sdk 

Client

The API client can be initialized as follows:

from sweetspot.client import Client 

client = Client(
    csrf_refresh_token='csrf_refresh_token', 
    csrf_access_token='csrf_access_token', 
    access_token_cookie='access_token_cookie', 
    refresh_token_cookie='refresh_token_cookie',
    environment='development')

API calls return an ApiResponse object that includes the following fields:

Field Description
status_code Status code of the HTTP response
reason_phrase Reason phrase of the HTTP response
headers Headers of the HTTP response as a dictionary
text The body of the HTTP response as a string
request HTTP request info
errors Errors, if they exist
body The deserialized body of the HTTP response
cookies The deserialized cookies of the HTTP response

Make Calls with the API Client

from sweetspot.client import Client

client = Client(
    csrf_refresh_token='csrf_refresh_token', 
    csrf_access_token='csrf_access_token', 
    access_token_cookie='access_token_cookie', 
    refresh_token_cookie='refresh_token_cookie',
    environment='development')

category_result = client.category.get_all_categories()
if category_result.is_success():
    categories = category_result.body

Authenticating the API Client

The client must obtain access tokens and cookies in order to call protected endpoints.

from sweetspot.client import Client 

client = Client() 

login_payload = {
    'email':email,
    'password':password
}

authentication_result = client.authentication.get_authentication_information(login_payload)
if authentication_result.is_success(): 
    client.update_config(**authentication_result.cookies)

#call protected endpoint 

category_result = client.category.get_all_categories()
if category_result.is_success():
    categories = category_result.body

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sweetspot-sdk-0.0.6.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sweetspot_sdk-0.0.6-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file sweetspot-sdk-0.0.6.tar.gz.

File metadata

  • Download URL: sweetspot-sdk-0.0.6.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.5

File hashes

Hashes for sweetspot-sdk-0.0.6.tar.gz
Algorithm Hash digest
SHA256 19105c5daa133699f9a3eacd27951d91a00cf1b9ef803bdc144848ad72f08d20
MD5 51fb8014b236fd1fc03721a05a0f5187
BLAKE2b-256 ac6913f386b0f1ab61ff097ed8f2b54f56425e5a9b7f4b6cf8679e892139130d

See more details on using hashes here.

File details

Details for the file sweetspot_sdk-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: sweetspot_sdk-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.5

File hashes

Hashes for sweetspot_sdk-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b455e5cdce533321e50bf564a278ef1baddbdebcced68562ac43542d9e290ebb
MD5 548770375a0bd77e3f4d8b8930a80705
BLAKE2b-256 d7cce5e0045892d2a60609c9aa608418ffb7bf1b85d08e764e024c41df2f8af6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page