Afișare articol

Descriere - Afișare articol

• Această secțiune este dedicată afișării unui articol

• Articolul returnat din acest apel se poate folosi pe orice factură

• Fiecare articol conține o proprietate de identificare a acestuia externalId

Model de utilizare API - Afișare articol

• Așa cum este explicat în zona de Informații generale utilizare API orice apel către API se face prin URL-ul de bază + endpoint-ul respectivei operații

Notă

• Verb: GET

• Endpoint: /{clientEid}/items/{item_external_id}

• Request parameter: {clientEid} si {item_external_id}

• Returns: Vezi Model Articol

• Type of return: Vezi Model Articol

Atenționare

• A se observa parametrul ~~~{clientEid}~~~ și tipul acestuia (path variable)

• A se observa parametrul {item_external_id} și tipul acestuia (path variable)

Validări - Afișare articol

La momentul executării acestui apel NU se vor verifica și valida informații

Mod de folosire - Wrapper - Afișare articol

• Dacă se folosește wrapper-ul scris în Python se utilizează astfel:

  1. Se preia token-ul Vezi Autorizarea

  2. Se apelează metoda specifică acestui request GET

  token_url = 'https://{ENVIRONMENT}.keez.ro/idp/connect/token'
  api_url = f'https://{ENVIRONMENT}.keez.ro/api/v1.0/public-api'
  
  client_eid = '{RECEIVED_CLIENT_EID}'
  application_id = '{RECEIVED_APPLICATION_ID}'
  secret = '{RECEIVED_SECRET}'
  
  api = KeezPublicApi(app=application_id, secret=secret, token_url=token_url, api_url=api_url)
  
  item_external_id = '{ID_EXTERN_ARTICOL}'
  
  result = api.item(client_eid, item_external_id)
  

Mod de folosire - Fără Wrapper - Afișare articol

class ItemService:
    def __init__(self):
        token = TokenService()
        self.auth_token = token.generate_token()
        self.token = f'{self.auth_token.get("token_type")} {self.auth_token.get("access_token")}'

        self.client_eid = token.client_eid
        self.api_endpoint = token.api_endpoint

    def getItem(self):
        item_external_id = '{ID_EXTERN_ARTICOL}'
        item_url = f'{self.api_endpoint}/{self.client_eid}/items/{item_external_id}'

        try:
            _req = requests.get(url=item_url, headers={'Content-Type': 'application/json', 'Authorization': self.token})
            _req.raise_for_status()
            return _req.json()
        except requests.HTTPError as ex:
            print_api_error(ex.response)
            return None
        except Exception as ex:
            print(f'Alta eroare: {ex}')
            return None


if __name__ == '__main__':
    service = ItemService()
    item = service.getItem()
    if item is not None:
        print(item)

Notă

Clasa TokenService() se găsește la secțiunea Autorizarea: Vezi Autorizarea

Notă

Funcția print_api_error() se găsește la secțiunea: Vezi Funcție utilitară print_api_error