NodeJS client: repo doc Browser client: repo vue3 example Python client: repo doc
We use proto3 as a base protocol in OpenAIP flow and the layer that on top of other transportation protocols. The goal has been to create a protool that is easy to pass and implement over any transport that support streaming data. For this reason, all messages are wrapped in an envelop message to add transport consistency.
All meesages require the current connection to be authenticated sending a SigninRequest first. In nodejs that would look something like this
const signinmessage = SigninRequest.create();
signinmessage.username = "henrik"
signinmessage.password = "SuperSecretPassword"
signinmessage.agent = "node"
signinmessage.version = "1.0.0"
signinmessage.longtoken = false
signinmessage.ping = true
signinmessage.validateonly = false
const data = Any.create({type_url: "type.googleapis.com/openiap.SigninRequest", value: SigninRequest.encode(signinmessage).finish()})
const envelope = Envelope.create({ command: "signin", data, jwt: opt.jwt });
We can now send this enveloper over any transport protocol, like GRPC, WebSocket, REST, named pipes or even raw TCP sockets
And Envelope needs a command, matching the any type assigned to data The client must assign a random and unqieu ID to each enveloper The client and server must assing the ID to rid when sending a response to a message The client can override who to run a message as, by setting jwt on a non-reply message, if that message type supports it The client also need to set seq starting from 1 and adding one for every message sent. The server must order all messages by seq number and process them in order. The Server must disconnect a client sending multiple packages with same seq number The server must disconnect a client sending to many unordered packages, to avoid needing to cache to many messages The client should send a traceid and spanid for each request to allow tracing across domains