airkey
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This Python package is automatically generated by the Swagger Codegen project:
- API version: v16.20.7
- Package version: 0.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://airkey.evva.com
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import airkey
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import airkey
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import airkey
from airkey.rest import ApiException
from pprint import pprint
# Configure API key authorization: X-API-Key
configuration = airkey.Configuration()
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# create an instance of the API class
api_instance = airkey.AreasApi(airkey.ApiClient(configuration))
area_id = 789 # int | Unique identifier of the area
try:
# Gets a specific area.
api_response = api_instance.get_area(area_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AreasApi->get_area: %s\n" % e)
# Configure API key authorization: X-API-Key
configuration = airkey.Configuration()
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# create an instance of the API class
api_instance = airkey.AreasApi(airkey.ApiClient(configuration))
lock_id = 789 # int | Filter areas by lock id (optional)
offset = 56 # int | Offset for paging (optional)
limit = 56 # int | Limit of result size (optional)
try:
# Gets all available areas.
api_response = api_instance.get_areas(lock_id=lock_id, offset=offset, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling AreasApi->get_areas: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://integration.api.airkey.evva.com:443/cloud
Class | Method | HTTP request | Description |
---|---|---|---|
AreasApi | get_area | GET /v1/areas/{areaId} | Gets a specific area. |
AreasApi | get_areas | GET /v1/areas | Gets all available areas. |
AuthorizationsApi | create_or_fetch_simple_authorization | POST /v1/authorizations/simple | Creates simple authorizations |
AuthorizationsApi | create_or_update_authorizations_with_advanced_options | POST /v1/authorizations/advanced | Creates new and updates existing authorizations (advanced version - can be used to create/update all types of authorizations). |
AuthorizationsApi | delete_authorization | PUT /v1/authorizations | Requests deletion of provided authorizations. |
AuthorizationsApi | get_authorization | GET /v1/authorizations/{authorizationId} | Gets a specific authorization. |
AuthorizationsApi | get_authorizations | GET /v1/authorizations | Gets all authorizations for locks and areas. |
BlacklistsApi | get_blacklists | GET /v1/blacklists | Gets all available blacklist entries. |
CreditsApi | get_credits | GET /v1/credits | Gets available credit information. |
CustomerApi | get_customer_data | GET /v1/customer | Gets customer details. |
EventsApi | get_event | GET /v1/events/{eventId} | Gets a specific event. |
EventsApi | get_events | GET /v1/events | Gets a list of events. |
HolidayCalendarsApi | create_holiday_calendar_slot | POST /v1/holiday-calendars/{holidayCalendarId}/slots | Adds a new holiday calendar slot to the holiday calendar. |
HolidayCalendarsApi | delete_holiday_calendar_slot | DELETE /v1/holiday-calendars/{holidayCalendarId}/slots/{holidayCalendarSlotId} | Deletes provided holiday calendar slot. |
HolidayCalendarsApi | get_holiday_calendar | GET /v1/holiday-calendars/{holidayCalendarId} | Gets a specific holiday calendar. |
HolidayCalendarsApi | get_holiday_calendar_slot | GET /v1/holiday-calendars/{holidayCalendarId}/slots/{holidayCalendarSlotId} | Gets a specific holiday calendar slot. |
HolidayCalendarsApi | get_holiday_calendars | GET /v1/holiday-calendars | Gets all holiday calendars. |
HolidayCalendarsApi | get_locks_by_calendar_id | GET /v1/holiday-calendars/{holidayCalendarId}/locks | Gets all locks using the holiday calendar. |
HolidayCalendarsApi | update_holiday_calendar | PUT /v1/holiday-calendars/{holidayCalendarId} | Updates the holiday calendar. |
HolidayCalendarsApi | update_holiday_calendar_slot | PUT /v1/holiday-calendars/{holidayCalendarId}/slots/{holidayCalendarSlotId} | Updates a holiday calendar slot of the holiday calendar. |
LockProtocolApi | get_lock_protocol | GET /v1/lock-protocol | Gets protocol of locks. |
LocksApi | get_lock | GET /v1/locks/{lockId} | Gets information of a specific lock. |
LocksApi | get_locks | GET /v1/locks | Gets information of all locks. |
LocksApi | update_lock | PUT /v1/locks/{lockId} | Updates the provided lock. |
MaintenanceTasksApi | get_maintenance_tasks | GET /v1/maintenance-tasks | Gets all maintenance tasks. |
MediaApi | assign_owner_to_medium | POST /v1/media/assign | Assigns a person to a medium for each provided assignment. |
MediaApi | cancel_medium_assignments | POST /v1/media/cancel-assignment | Cancels assignments of media. |
MediaApi | create_phones | POST /v1/media/phones | Adds list of new phones. |
MediaApi | deactivate_medium | POST /v1/media/{mediumId}/deactivate | Deactivates provided medium. |
MediaApi | delete_phones | DELETE /v1/media/phones | Deletes provided phones. |
MediaApi | empty_medium | POST /v1/media/{mediumId}/empty | Empties provided medium. |
MediaApi | generate_pairing_code_for_phone | POST /v1/media/phones/{phoneId}/pairing | Generates a new pairing code for a phone. |
MediaApi | get_card | GET /v1/media/cards/{cardId} | Gets information of specific card. |
MediaApi | get_cards | GET /v1/media/cards | Gets information of all cards. |
MediaApi | get_media | GET /v1/media | Gets information of all media. |
MediaApi | get_medium | GET /v1/media/{mediumId} | Gets information of a specific medium. |
MediaApi | get_phone | GET /v1/media/phones/{phoneId} | Gets information of specific phone. |
MediaApi | get_phones | GET /v1/media/phones | Gets information of all phones. |
MediaApi | reactivate_medium | POST /v1/media/{mediumId}/reactivate | Reactivates provided medium. |
MediaApi | reset_pin_of_phone | POST /v1/media/phones/{phoneId}/pin-reset | Resets PIN of the phone. |
MediaApi | send_registration_code_to_phone | POST /v1/media/phones/{phoneId}/send-registration-code-with-parameters | Sends pairing code to phone while the SMS text to be sent can be configured. |
MediaApi | send_registration_code_to_phone1 | POST /v1/media/phones/{phoneId}/send-registration-code | Sends pairing code to phone. |
MediaApi | update_cards | PUT /v1/media/cards | Updates list of cards. |
MediaApi | update_phones | PUT /v1/media/phones | Updates list of phones. |
MediumProtocolApi | get_medium_protocol | GET /v1/medium-protocol | Gets protocol of media. |
PersonsApi | create_persons | POST /v1/persons | Adds list of new persons. |
PersonsApi | delete_persons | DELETE /v1/persons | Deletes provided persons. |
PersonsApi | get_person | GET /v1/persons/{personId} | Gets a specific person. |
PersonsApi | get_persons | GET /v1/persons | Gets all persons. |
PersonsApi | update_persons | PUT /v1/persons | Updates list of persons. |
PublicMgmtApi | reset_test_data | POST /v1/public-mgmt/reset-test-data | Resets test data in the integration environment. |
SendAKeyApi | send_a_key | POST /v1/send-a-key | Sends a registration code to the phone and creates all necessary prerequisites if needed. |
SystemProtocolApi | get_system_protocol | GET /v1/system-protocol | Gets system protocol. |
Documentation For Models
- AppPairedEventDetails
- Area
- AreaPagingList
- Authorization
- AuthorizationChange
- AuthorizationCreate
- AuthorizationDelete
- AuthorizationInfo
- AuthorizationPagingList
- AuthorizationSyncDetails
- AuthorizationSynchronizedEventDetails
- BlacklistEntry
- Card
- CardPagingList
- CreditInfo
- Customer
- Event
- EventDetails
- EventPagingList
- FixedMediumSimpleAuthorizationCreate
- HolidayCalendar
- HolidayCalendarList
- HolidayCalendarSeries
- HolidayCalendarSeriesCreate
- HolidayCalendarSlot
- HolidayCalendarSlotCreate
- HolidayCalendarSlotDelete
- HolidayCalendarSlotUpdate
- JsonNode
- Lock
- LockDoor
- LockFirmware
- LockMaintenanceTask
- LockPagingList
- LockProtocol
- LockProtocolDetails
- LockProtocolEntry
- LockProtocolEvent
- LockProtocolPagingList
- MaintenanceTaskPagingList
- Medium
- MediumAssignment
- MediumPagingList
- OneDayAuthorizationInfo
- PeriodicalAuthorizationInfo
- PeriodicalPeriod
- PermanentAuthorizationInfo
- Person
- PersonCreate
- PersonPagingList
- Phone
- PhoneCreate
- PhonePagingList
- PhoneSettings
- SendAKeyPhone
- SendAKeyRequest
- SendAKeyResponse
- SendRegistrationCodeRequest
- SimpleArea
- SimpleAuthorizationCreate
- SimpleAuthorizationInfo
- SimpleLock
- SimpleMedium
- SystemProtocol
- SystemProtocolDetails
- SystemProtocolEntry
- SystemProtocolEvent
- SystemProtocolPagingList
- UnlockingEventDetails
Documentation For Authorization
X-API-Key
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header