fichario-client 0.1.5

API Client for Fichar.io

Fichar.io API Client

The Fichario Client Python library serves as a client for interacting with the API provided by Fichar.io. This API client simplifies the process of authenticating users and making various requests to the API's endpoints. The client uses JSON Web Tokens (JWT) for authentication and supports retrieving user credentials, company information, device details, payload data, etc.

Installation

You can install the package using pip:

pip install fichario-client

Usage

1. Import the FicharioClient class:

from fichario_client.client import FicharioClient

2. Create an instance of the FicharioClient class with your user credentials:

client = FicharioClient(email="[e-mail]", password="your_password")

3. Access API functionalities using the client's methods:

• Retrieve user credentials:

user_credentials = client.get_user_credentials()
print(user_credentials)

• Retrieve your company's information:

company_info = client.get_my_company()
print(company_info)

• List your devices:

devices = client.list_my_devices()
print(devices)

• Get information about a specific device:

device_id = "your_device_id"
device_info = client.get_device(deviceId=device_id)
print(device_info)

• Retrieve payload data from a device:

payload_data = client.get_payload(deviceId=device_id, get_all=True)
print(payload_data)

• Retrieve raw payload data from a device:

raw_payload_data = client.get_raw_payload(deviceId=device_id)
print(raw_payload_data)

• Get device information:

device_info = client.get_device_info(deviceId=device_id)
print(device_info)

• Retrieve alarms associated with a device:

alarms = client.get_device_alarms(deviceId=device_id)
print(alarms)

• Retrieve alarm history associated with a device:

alarm_history = client.get_device_alarms_history(deviceId=device_id)
print(alarm_history)

Note: Ensure you have all the requirements for the library installed before using the library FicharioClient.

Contributing

Contributions to this API client are welcome. If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on the project's GitHub repository.

License

This project is licensed under the MIT License. You can find the license details in the LICENSE file in the project repository.

Disclaimer

This API client is designed to interact with the "https://api.fichar.io/" API based on the available information. Be sure to refer to the API documentation for detailed information about endpoints, authentication, and usage limits.

Stay in touch

• Author - Ronald Lopes
• Website - https://fichar.io