API-kulcsok

A Billcity API-ja kétféle API-kulccsal hívható:

- céges API-kulcs: a végfelhasználók egy konkrét céghez kötött API-kulccsal hívják az API-t, ez az a kulcs, amelyet a Billcity-ben a Beállítások menü API kapcsolat pontjában lehet generálni.

- előfizetői API-kulcs: azokhoz a funkciókhoz, amelyhez előfizetői jogok szükségesek, speciális, ún. előfizetői kulcsra van szükségünk

Ahol az előfizetői API-kulcsot kell használni, azoknál a műveleteknél jelezzük ezeken az oldalakon. Ahol külön nem jelezzük, ott a céges API-kulcsot kell használni.

Előfizetés viszonteladói ügyfélként

Ahhoz, hogy viszonteladóként előfizessünk a Billcity szolgáltatásaira, a következő adatokra lesz szükségünk:

• az előfizetői API-kulcsra,
• az előfizetőnk id-jára,
• az előfizetendő csomag id-jára.

Lépései:

• Feltételezzük, hogy:
  • az ügyfélnek már van (előfizetés nélküli) Billcity-regisztrációja,
  • illetve kért API-kulcsot a cégének a Billcity-ben (Beállítások / API kapcsolat).
• A külső rendszerben az ügyfél API-kulcsával meghívjuk a Find Current Business endpointot, a válaszban szerepel a business id, ezt eltároljuk.
• Az előfizetői API-kulccsal meghívjuk a Create Subscription endpointot, ahol a fenti három adatot, illetve az előző lépésben eltárolt business id-t kell megadni
• Ezután az ügyfél saját API-kulcsával hozzáfér a Billcity API-jához

További műveletek:

• Find Subscriptions by Subscriber: az előfizetőnk aktuális előfizetéseinek listázása
• Unsubscribe Subscription: leiratkozás egy előfizetésről