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.4.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.4-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sweetspot-sdk-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 d455a6937e2b3021a1d475093f7a43877f31da51203add8cb8d929ebaa0e1832
MD5 0313222a4df44064395a28fa8ed1584d
BLAKE2b-256 ef53e6d3a40a7e7eae5f736781136267c08186161525634168aff5541d49a4d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sweetspot_sdk-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 27.0 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 860a39c55adb0ef5a9887ec36fec4d939f6dd712598c7f8bbd47917604cde8d6
MD5 6bccd4a034aaeee3992bcd3381956a9a
BLAKE2b-256 7550d066532ac39e0c8a8aabb938a4f71c1da958df23bdcf80d1bc8933f57f32

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