Skip to content

BrianGouge-AI/Breezy-API

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python class for consuming Breezy's API.

Breezy's API documentation can be found at https://https://developer.breezy.hr/

Requirements

Requests and PyYAML is necessary to run this code:

pip install requests pyyaml

Usage

Before using the code, make sure to create an auth.yaml file and include your credentials:

email: your@email.here
password: breezyPassword

Then you can import the BreezyAPI class and make your requests:

# import BreezyAPI from breezy.py
from breezy import BreezyAPI

# create a BreezyAPI object
breezy = BreezyAPI()


# Upon instantiaton, the breezy object will automatically call the /signin
# endpoint and obtain a token, if it fails to do it will raise an exception.
print(breezy.token)  # will print the generated token

# you will now be able to communicate with the API

# for example, we can get the companies' ids, which will be required for most
# of Breezy's API calls
companies = breezy.call(
    "companies" 
)

About

Python class for consuming BreezyHR's API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%