https://github.com/caub/ta_orgapi
Total Access Organization API
https://github.com/caub/ta_orgapi
Last synced: over 1 year ago
JSON representation
Total Access Organization API
- Host: GitHub
- URL: https://github.com/caub/ta_orgapi
- Owner: caub
- License: unlicense
- Created: 2020-04-09T13:00:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-09T13:05:49.000Z (about 6 years ago)
- Last Synced: 2025-01-28T02:11:09.050Z (over 1 year ago)
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Total Access Organization API
## Prerequisites
* You should understand what are [WebHooks](https://webhooks.pbworks.com/w/page/13385124/FrontPage) and how to receive/parse them on the back end.
* You should understand [Protocol Buffers](https://developers.google.com/protocol-buffers/docs/proto3) and [gRPC](https://grpc.io/docs/guides/concepts/).
* You should have `protoc` compiler with support for gRPC and your programming language of choice installed. See examples on [gRPC website](https://grpc.io/docs/quickstart/go/).
* Get gRPC server URL from your Total Access contact.
## Contents
* webhooks/biz_operation.json - example of HTTP webhook;
* proto/entities.proto - set of domain entities used within the API;
* proto/google/* - (auxiliary) set of Google protocol buffers used by domain entities;
* proto/access_logs.proto - Access Logs gRPC service definitions;
* proto/biz_operations.proto - Biz Operations gRPC service definitions;
* proto/checkpoints.proto - Checkpoints gRPC service definitions;
* proto/indoor_sessions.proto - Indoor Sessions gRPC service definitions;
* proto/organizations.proto - Organizations gRPC service definitions;
* proto/schedules.proto - Schedules gRPC service definitions;
* proto/security_cameras.proto - Security Cameras gRPC service definitions;
* proto/security_devices.proto - Security Devices gRPC service definitions;
* proto/sessions.proto - Sessions (sign in/out) gRPC service definitions;
* proto/user_groups.proto - User Groups gRPC service definitions;
* proto/user_Group_sets.proto - User Group Sets gRPC service definitions;
* proto/users.proto - Users gRPC service definitions;