Skip to main content
Rate this article:

Getting Started with OakOS

There are various ways to communicate with OakOS.

OakOS Dashboard

Using the Oak Platform Dashboard

Our Dashboard is basically a web wrapper that performs the same REST calls that are publicly available. Additionally the dashboard provides metadata around things like command history, machine state, etc.

OakOS Dashboard API

Accessing a machines gRPC services using our API

Our OakOS REST API allows you to skip local prerequisite installs, or just simply issue commands remotely using the same gRPC API methods. Postman is a very easy way to access and test an OakOS system

Getting started with our Dashboard API is easy and allows you to access all the OakOS gRPC API. To get started you can read and download our postman collection at https://api.dashboard.zivelo.com/

OakOS Platform API

We now have a REST API to the OakOS Platform that allows you to communicate directly to an OakOS unit.

Getting started with our Platform API is easy and allows you to access all the OakOS gRPC API. To get started you can read and download our postman collection at https://api.dashboard.zivelo.com/

gRPC Services

You can send commands to the OakOS gRPC service from your application to access information and preform commands on an OakOS machine. First you will need to understand our system and what is accessible as well as install some prerequisites.

  • Our gRPC services are defined in the platform-protos repository on GitHub
  • We also have a Node.js module which wraps the above gRPC methods into an easy to use library. See node-oak-platform, which also has some handy examples
  • Get started using gRPC with their excellent Quick Start Guide
Rate this article:
Logo of Verifone