Brani Balič csatlakozás API-n keresztül

A rendszerének a Brani Balič szállítási szoftverhez való csatlakoztatása 3 részből Brani Balič :

• Információk küldése az e-boltról
• Megrendelések küldése
• Webhookok az információk visszakereséséhez

Shoptet, Upgates, Money vagy Flexi szolgáltatást használ? A csatlakozás már készen áll, vegye fel velünk a kapcsolatot a support@brani.cz címen.

Információk az e-boltról

Ahhoz, hogy Brani Balič-csal megfelelően tudjunk együttműködni az Ön e-boltjában, szükségünk van néhány alapvető adatra az Ön e-boltjáról, mint például a szállítás, a fizetés, a megrendelések állapota és hasonló adatok.

Nem szükséges, hogy ezek a számlapok pontosan megegyezzenek az Ön e-boltjával, sok esetben célszerű őket módosítani.

Ezt az endpointot csak akkor kell meghívni, ha valami megváltozott.

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

API hívás bemutatója

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 a megrendelések upsert műveletéhez (a megrendelés egyedi azonosítója a „code”. Ha több, azonos „code”-val rendelkező kérést küld, akkor az adott megrendelést frissítjük)
• DEL végpont a megrendelés törléséhez

Kérjük, olvassa el a fő sémát (nem csak a mintát), amely tartalmazza az összes elérhető rendelési attribútumot.

Webhookok

Ahhoz, hogy a Brani Baliče-től információkat kapjon a megrendelés állapotáról, webhookokat kell implementálnia. 4 fő webhook-típust támogatunk (balic_packed, package_number, status_change és order_history).

Nem szükséges minden webhookot implementálni, ha nincs rájuk szükség. Amint elküldjük a webhookot, 200-as visszatérési kódot várunk. Ha nem kapunk 200-as kódot, egy idő után újra megpróbáljuk. Összesen 3 kísérletet teszünk a webhook elküldésére.

Minden eseményt ki lehet írni ezen az endpointon keresztül, ahol például csak a kézbesítetlen webhookokat lehet kiírni, hogy szinkronizálja azokat az eseményeket, amelyeket nem sikerült kézbesíteni.

Alkalmazási API

Ha pontosabb információkra van szüksége a Brani Baliče-ről, akkor gyakorlatilag mindent megtalálhat, ami a balic.brani.cz oldalon elérhető. Alkalmazásunk API-t használ, amelyet Ön is használhat.

A dokumentációt itt találja. Vagy figyelje a böngésző hálózati kommunikációját, miközben ebben az alkalmazásban dolgozik. Frontendünk ezzel az API-val működik.

Engedélyezés

Ez az API nem ugyanazt a tokent használja, mint a nyilvános API, hanem e-mail címmel és jelszóval jelentkezik be a mi auth szerverünkre, amely korlátozott érvényességű tokent generál Önnek.

Ideális esetben tehát hozzon létre egy új felhasználót kizárólag az API kezeléséhez. Ezzel az API-val például teljes mértékben összeállíthatja a megrendeléseket; ez a felhasználó szerepelni fog a változások naplójában.
Itt található az auth API dokumentációja.

API hívás bemutatója

Ez a Python szkript bemutatja, hogyan lehet token-t szerezni az auth-on keresztül, és hogyan lehet azt az endpoint-on felhasználni a Brani Balič beállításainak megszerzé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.")