Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.66 KB

README.md

File metadata and controls

38 lines (27 loc) · 1.66 KB
Raw

NERIS API Client

A Python class to interact with the NERIS API programmatically.

Usage

To install:

pip install neris-api-client

Package lives on pypi: NERIS API Client

The client requires a username and password for authentication and authorization of requests unless the env argument is set to local at instantiation. The local environment is intended for development use on local machines and bypasses auth.

from neris_api_client import NerisApiClient

client = NerisApiClient(username="[email protected]", password="*******", env="test")

# Get an entity
entity = client.get_entity("FD24027240")

API auth tokens are cached locally in ./.token_cache. If there are auth issues first try instantiating the client with use_cache=False keyword argument or deleting the token cache.

Disclaimer

The models in this package are generated using datamodel-code-generator and are not guaranteed to contain all of the information present in the full specification. The generated models are used to validate request payloads prior to API submission.

Additional Information

To ask a question, make a suggestion, or otherwise get help with the NERIS API Client, please visit the NERIS helpdesk.

Beta sandbox users:

  • Be sure to use the test environment with the NERIS API Client. You will not be able to authenticate requests in the other environments.
  • For the beta testing period, your user is only authorized to perform actions on behalf of the FSRI Fire Department FD24027214.