Tutorial: Automatizza le chiamate SP-API utilizzando un Python SDK
Automatizza le tue chiamate SP-API con lo scambio e l'autenticazione di token Login with Amazon (LWA).
Questo tutorial fornisce tutti i dettagli necessari per generare un SDK Python con scambio di token e autenticazione Login with Amazon (LWA), per creare la tua applicazione senza problemi. Imparerai i prerequisiti necessari per creare l'SDK Python e visualizzerai anche un esempio utilizzando l'API Selling Partner per gli ordini e lo Swagger Code Generator.
Puoi utilizzare questo SDK per integrare le funzionalità di Amazon Marketplace nelle tue applicazioni, tra cui l'accesso alle informazioni sui prodotti, la gestione degli ordini, la gestione delle spedizioni e altro ancora.
Tutorial
Il seguente tutorial ti aiuterà a configurare il tuo Python SDK per automatizzare le chiamate SP-API.
Prerequisiti
Per completare questo tutorial, sono necessari i seguenti prerequisiti:
- Un'app ibrida o SP-API in stato di bozza o pubblicata
- Software per l'ambiente di sviluppo integrato (IDE)
- Python (versione 3.6 o successiva)
swagger-codegen-cli-2.3
(o successivo) Questo strumento viene utilizzato per generare codice client Python dalle definizioni Swagger dell'SP-API.
Prima che la tua applicazione possa connettersi all'API del partner di vendita, devi registrarla e deve essere autorizzata da un partner di vendita. Se non disponi di un'app ibrida o SP-API, segui i passaggi per registrati come sviluppatore, registra la tua candidatura, e Autorizzazione delle applicazioni Selling Partner API. Quindi, torna a questo tutorial.
Quindi, configura il tuo spazio di lavoro per il tutorial.
Fase 1. Configura il tuo spazio di lavoro
-
Sul tuo disco locale, crea una directory per questo progetto, assegnagli un nome
SPAPI_Python_SDK
e vai alla nuova directory. -
Clona il repo per clienti.
-
Scarica i seguenti strumenti.
- Software IDE (questa procedura dettagliata utilizza Visual Studio IDE su sistema operativo Windows)
- Python (versione 3.6 o successiva). È possibile scaricare questo software da python.org.
-
Esegui il seguente comando nel tuo terminale per scaricare Swagger Code Jar:
`wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.13/swagger-codegen-cli-2.4.13.jar -O swagger-codegen-cli.jar` -
Copia
swagger-codegen-cli.jar
nella tua rubrica localeC:\\SPAPI_Python_SDK
. -
Esegui il seguente comando nel tuo terminale per installare Python
backoff
libreria nel tuo ambiente:pip install backoff -
In GitHub, vai a
https://github.com/amzn/selling-partner-api-models/tree/main/models
ed esegui il seguente comando per clonare ilselling-partner-api-models
repository nella tua directory localeC:\\SPAPI_Python_SDK
.git clone https://github.com/amzn/selling-partner-api-models
Ora che hai completato la configurazione richiesta, il passaggio successivo è generare l'SDK Python con le classi di autenticazione e autorizzazione scaricate nella tua directory locale C:\\SPAPI_Python_SDK
.
Fase 2 Genera un client Python dalle definizioni di Swagger
-
Individua il file JSON di Swagger per Modello API SP-API che desideri utilizzare (ad esempio, Orders API) dalla tua directory locale
C:\\SPAPI_Python_SDK
. -
Esegui il seguente comando nel tuo terminale per generare il codice client. Assicurati di sostituire i percorsi e il modello API con le tue impostazioni.
java -jar /[path_to_swagger_jar]/swagger-codegen-cli.jar generate -l python -t /[path_to_mustach_resources]/resources/ -D packageName=swagger_client -o /[path_to_client_folder]/client/[SP-API_NAME] -i /[path_to_model_folder]/models/[SP-API_NAME]/SP-API.json
Ora che hai generato un client Python, devi integrare il modello di autenticazione.
Fase 3. Integra il modulo di autenticazione
- Individua il
auth
espapi
cartelle con codici cliente inC:\\SPAPI_Python_SDK
, la directory in cui è stato scaricato l'SDK. - Aggiorna i percorsi nei seguenti file Python:
spapiclient.py
eLwaRequest.py
. Ogni file contiene istruzioni su cosa aggiornare.
Con l'autenticazione impostata, ora sei pronto per configurare il pacchetto Python SDK.
Fase 4. Configura il pacchetto Python SDK
- Naviga verso
C:\\SPAPI_Python_SDK
la directory in cui è stato generato l'SDK. - Usa il codice seguente per creare un
setup.py
fascicolo. Questo file è necessario per impacchettare il tuo SDK. Assicurati di sostituire le informazioni nell'esempio con le informazioni relative al pacchetto e alle dipendenze.
from setuptools import setup, find_packages
setup(
name='SellingPartnerAPIAuthAndAuthPython', # Replace with your package's name
version='1.0.0', # Replace with your package's version
package_dir={'': 'src'}, # Replace 'src' as necessary
packages=find_packages(where='src'),
install_requires=[line.strip() for line in open("requirements.txt", "r")],
description='A Python SDK for Amazon Selling Partner API',
long_description=open('README.md').read(),
long_description_content_type='text/markdown',
url='TBD'
)
Con l'SDK Python configurato, ora sei pronto per creare un'istanza dell'API Orders.
Fase 5. Crea un'istanza dell'API Orders e richiama un'operazione
Di seguito è riportato un esempio di come utilizzare l'SDK Python con l'API Orders per creare un getOrders
richiesta. Aggiorna il codice con le tue informazioni e poi esegui il codice nel tuo terminale.
if __name__ == "__main__":
from auth.credentials import SPAPIConfig
config = SPAPIConfig(
client_id="Your client-id",
client_secret="Your client-secret",
refresh_token="Your refresh-token",
region="NA", # Possible values NA, EU, FE, and SANDBOX
scope = None # Required for grant_type='client_credentials' ; Possible values "sellingpartnerapi::notifications" and "sellingpartnerapi::migration"
)
from spapi.spapiclient import SPAPIClient
# Create the API Client
print("Config and client initialized...")
api_client = SPAPIClient(config)
marketplace_ids = ["ATVPDKIKX0DER"]
created_after = "2024-01-19T00:00:00"
orders_api = api_client.get_api_client('OrdersV0Api')
orders_response = orders_api.get_orders(marketplace_ids=marketplace_ids, created_after=created_after)
print("Orders API Response:")
print(orders_response)
Attenzione
Non inviare mai questo file al tuo sistema di controllo della versione in quanto contiene informazioni sensibili. Assicurati che queste credenziali LWA siano archiviate in modo sicuro in un formato crittografato.
Un codice di stato 200 indica che la chiamata API è andata a buon fine.
Fase 6. Connettiti all'API Selling Partner utilizzando l'SDK Python generato
Esegui i seguenti comandi nel tuo terminale per creare e installare il tuo SDK localmente:
python3 setup.py sdist bdist_wheel
pip install dist/{YourPackageName}-1.0.0-py3-none-any.whl
Esegui il seguente script di test nel tuo terminale per testare l'SDK Python:
python test.py
Un codice di stato 200 indica che la chiamata API è andata a buon fine.
Conclusione
In questo tutorial, hai imparato come automatizzare le chiamate SP-API utilizzando un SDK SP-API per Python. Nella procedura dettagliata, hai imparato a configurare il tuo spazio di lavoro, generare un Python SDK for Selling Partner API, connetterti all'API Orders ed effettuare la tua prima chiamata API.
Updated 23 days ago