Introduction

The Synchro Service lets a practice management software partner keep Ubikap up to date with its own data: office users, workspaces (dossiers), their accesses, stockholders, governance and the persons and companies attached to them. Your software tells Ubikap what changed; Ubikap fetches the data from your API and applies it asynchronously.

Like the Public API, it is a gRPC server with type-safe messages generated from our .proto files, also served by a REST gateway over plain HTTP and JSON. It implements server reflection, so grpcurl and Postman can list its methods without the .proto files.

Note

The Synchro Service is open to integration partners only. Contact us to get a Synchro Service user and the list of RPCs it may call.

How a synchronization works

1. Log in for one office with AuthenticationService.LogIn: see Authentication.
2. Send the tasks to run with SynchronizationService.PostAsyncTasks. Ubikap queues them and answers at once with a synchronizationId.
3. Ubikap runs the tasks in the background, reading the data from your API.
4. Follow the progress with GetSynchroState (one synchronization) or GetGlobalSynchroState (the office, or one workspace).

See Synchronizations for the task types, their order, states and retries.

Where to go next

• Getting Started: generate a client and make your first call.
• Synchronize a workspace: post a full workspace synchronization and poll it until it ends.
• gRPC: endpoint, .proto files, server reflection and status codes, with grpcurl and Postman examples.
• API reference: every RPC with its messages and a grpcurl example.