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.1.4.tar.gz (13.0 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.1.4-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sweetspot-sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.6.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for sweetspot-sdk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 7943785f8cec50097732323a241f158545ebde7994ec84abd4f8b052d15c8068
MD5 acd88a4644d3c3a5e838acdd7c14332e
BLAKE2b-256 185f4583c6b24e80014acc68e0dff0e17469a85027a9d23d29a851e0b1edc12b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sweetspot_sdk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 25.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.6.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for sweetspot_sdk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7d91aae630f2af5bbf2a7da0a3b7a408abcc871f533aa3f6907a26d2395fe952
MD5 5a7218dcb2508bf9d4c110820ea25b11
BLAKE2b-256 39302df19d7a5884ffa9ff00f6c9e91af62d8f277e452c5014da0db08322608f

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