# Cégjelző User Auth API leírás (v1)

Utolsó módosítás dátuma: 2019-06-17

# API elérési címek

Teszt API endpoint: https://api-user-management-dev.api.cegjelzo.com/v2 (opens new window)
Swagger URL: https://api-user-management-dev.api.cegjelzo.com/v2/docs (opens new window)

Éles API endpoint: https://api-user-management.api.cegjelzo.com/v2 (opens new window)
Swagger URL: https://api-user-management.api.cegjelzo.com/v2/docs (opens new window)

# Általános információk

A Cégjelző Auth API az előfizető felhasználóihoz tartozó jogosultságok kezelésére szolgál. Ennek segítségével adható meg, hogy adott alfelhasználó előfizetése mikortól meddig tart.

FONTOS

A Cégjelző API nem szerződésszerű használata esetén a rendszer automatikusan korlátozza az adott ügyféltől érkező összes hívást, ezért javasoljuk hogy élesítés előtt fokozott figyelemmel nézzék át a beépített terméket.

Az API használata közben előfordul, hogy az ügyfél speciális vagy ékezetes karaktereket, illetve szóközöket vagy írásjeleket is használ egyes lekérdezések során. Ezeket kérjük minden esetben szíveskedjenek URL encode-oldva továbbítani az API felé, mivel a rendszer csak így tudja őket értelmezni.

# API végpontok

# 1. Ügyfélhez tartozó előfizetők lekérdezése

HTTP Method: GET

Végpont: /users

Headers (Fejléc):

  • X-Api-Key: Kötelező. Kapott Api key.
  • X-Customer-Token: Kötelező. Kapott Customer Token.

Minta lekérdezés: /users

Válasz:

[
  {
    "client_id": "CEG-004735",
    "created_at": "2018-02-11",
    "valid_from": "2018-02-11",
    "valid_to": "2019-02-11"
  }
]

A hívás fejlécében szereplő X-Api-Key a megrendelő api kulcsa, amit minden hívásnál meg kell adni. Ez authentikálja a hívó felet. Az X-Customer-Token tartalmazza a szerződéses adatokat.

A válasz tartalmazza az ügyfélhez tartozó összes API alfelhasználót.

# 2. Ügyfélhez tartozó előfizető lekérdezése client-id alapján

HTTP Method: GET

Végpont: /users/<client_id>

Headers (Fejléc):

  • X-Api-Key: Kötelező. Kapott Api key.
  • X-Customer-Token: Kötelező. Kapott Customer Token.

Minta lekérdezés: /users/004735

Válasz:

[
  {
    "client_id": "CEG-004735",
    "created_at": "2018-02-11",
    "valid_from": "2018-02-11",
    "valid_to": "2019-02-11"
  }
]

A hívás egy adott API felhasználó adatait adja vissza.

Fontos! A client-id-nak nem kell tartalmazni a cégnév prefix-et, sem kötőjelet, kizárólag a belső rendszerben szereplő azonosítót kell átadni.

Pl. CEG-0001 esetén csak a 0001

# 3. Ügyfélhez tartozó előfizető módosítása client-id alapján

HTTP Method: PATCH

Végpont: /users/<client_id>

Headers (Fejléc):

  • X-Api-Key: Kötelező. Kapott Api key.
  • X-Customer-Token: Kötelező. Kapott Customer Token.

Body (tartalom JSON formátumban):

{
	"valid_from": "2018-11-12",
	"valid_to": "2019-11-12"
}

Minta hívás: /users/004735

Válasz:

[
  {
    "client_id": "CEG-004735",
    "created_at": "2018-02-11",
    "valid_from": "2018-02-11",
    "valid_to": "2019-02-11"
  }
]

A hívás egy adott API felhasználó adatait módosítja. A valid_from és valid_to értékek nem kötelezőek, amennyiben nem kerül valamelyik megadásra az érték az adatbázisban nem módosul.

# Kapcsolat

Bármilyen felmerülő kérdés, vagy pontosítás esetén az alábbi e-mail címen elérhetőek vagyunk: support@cegjelzo.hu