Brani Balič - kapcsolat API-n keresztül

Brani Balič A rendszer csatlakoztatása a diszpécser szoftverhez 3 részből áll:

• E-shop információk küldése
• Megrendelések küldése
• Webhooks az információk visszakapásához

Használja a Shoptet, Upgates, Money vagy Flexi termékeket? brani Készen állunk a csatlakozásra, lépjen kapcsolatba velünk a support@ .cz címen.

Információk a webáruházról

Brani e-shopAhhoz, hogy a Packerrel megfelelően tudjunk dolgozni, szükségünk van néhány alapvető információra az Ön webáruházáról, mint például a szállítás, fizetés, rendelési státuszok és így tovább.

Nem szükséges, hogy ezek a tárcsák pontosan megegyezzenek az Ön webáruházával, sok esetben hasznos lehet módosítani őket.

Ezt a végpontot csak akkor kell meghívni, ha valami megváltozott.

• GET végpont az aktuális adatok lekérdezéséhez (nullát ad vissza, ha nem küld nekünk semmit)
• POST végpont adatfrissítéshez

Minta API-hívás

import requests
url = "https://api.brani.cz/eshop/info"
headers = {
    "Authorization": "Bearer VAS_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

Megrendelések

A megrendeléseket JSON formátumban küldje el nekünk. A következő végpontok állnak rendelkezésre:

• POST végpont upsert megrendeléshez (a megrendelés egyedi azonosítója a "code". Ha több kérést küld ugyanazzal a "kóddal", frissítjük a megrendelést)
• DEL végpont a rendelés törléséhez

Kérjük, tekintse át a fő sémát (nem csak a mintát), amely felsorolja az összes rendelkezésre álló rendelési attribútumot.

Webhooks

Brani Ahhoz, hogy a Packertől információkat kapjon arról, hogy mi történik a megrendeléssel,webhookokat kell implementálnia. A webhookok 4 fő típusát támogatjuk (package_packed, package_number, status_change és order_history).

Nem szükséges az összes webhookot megvalósítani, ha nincs rájuk szükség. Amint elküldünk egy webhookot, 200-as visszatérési kódot várunk. Ha nem kapunk 200-as kódot, akkor egy pillanat múlva újra megpróbáljuk. Összesen 3 kísérletet teszünk egy webhook elküldésére.

Ezen a végponton keresztül minden eseményt ki lehet dobni, ahol például csak a nem kézbesített webhookokat lehet kiírni, hogy szinkronizálja azokat az eseményeket, amelyeket nem sikerült kézbesítenie.

Alkalmazás API

Brani braniHa konkrétabb információra van szüksége a Balicról, abalic. .cz oldalon gyakorlatilag minden elérhető. Alkalmazásunk egy API-t használ, amelyet Ön is használhat.

A dokumentáció itt található. Alternatív megoldásként a böngészőben is figyelemmel kísérheti a hálózati kommunikációt, miközben ebben az alkalmazásban dolgozik. Frontendünk ezzel az API-val működik.

Engedélyezés

Ezzel az API-val nem ugyanazt a tokent használja, mint a nyilvános API-val, hanem bejelentkezik az auth szerverünkön e-mail címével és jelszavával, amely egy korlátozott érvényességű tokent generál Önnek.

Ideális esetben tehát csak az API kiszolgálásához adjon hozzá egy új felhasználót.
Potenciálisan teljesen össze lehet csomagolni a megrendeléseket például ezen az API-n keresztül, ez a felhasználó be lesz írva a változásnaplóba. Itt van az auth APIdokumentációja.

Minta API-hívás

Brani Ez a Python szkript egy példát mutat a token auth-n keresztül történő megszerzésére, és annak egy végpontban történő felhasználására a Packer beállítások lekérdezéséhez.

import requests

# URL pro přihlášení
login_url = 'https://auth.brani.cz/api/login/'

# Data pro přihlášení
login_data = {
    'username': 'meno@mail.cz',
    'password': 'heslo'
}

# Přihlášení a získání access tokenu
response = requests.post(login_url, data=login_data)
response_data = response.json()
access_token = response_data.get('access_token')

# Pokud je access token dostupný, pokračujeme s GET požadavkem
if access_token:
    settings_url = 'https://balic.brani.cz/api/settings/?calculate_filters=true'
    headers = {
        'Authorization': f'Bearer {access_token}'
    }
    settings_response = requests.get(settings_url, headers=headers)
    settings_data = settings_response.json()
    print(settings_data)
else:
    print("Nepodařilo se získat access token.")