Skip to content
Ubikap

Call the service with grpcurl or Postman

Both tools discover the service through server reflection: no code generation is needed.

grpcurl

Section titled “grpcurl”

Install grpcurl, then list the services and describe one:

Terminal window
grpcurl synchro.api.external-integration.ubikap.dev:443 list
grpcurl synchro.api.external-integration.ubikap.dev:443 describe services.synchronization.v1.SynchronizationService

Log in — LogIn needs no token:

Terminal window
grpcurl -d '{
  "officeScope": { "target": { "office": { "externalId": "12345" } } },
  "userUuid": "01920000-0000-7000-8000-000000000000",
  "userCode": "12345678"
}' synchro.api.external-integration.ubikap.dev:443 services.authentication.v1.AuthenticationService/LogIn

Then send the token in the authorization metadata:

Terminal window
TOKEN='<token returned by LogIn>'


grpcurl -H "authorization: Bearer $TOKEN" -d '{
  "tasks": [
    {
      "synchronizeFullWorkspace": {
        "target": { "workspace": { "externalId": "4242" } },
        "source": { "credential": { "externalId": "67890" } }
      }
    }
  ]
}' synchro.api.external-integration.ubikap.dev:443 services.synchronization.v1.SynchronizationService/PostAsyncTasks


grpcurl -H "authorization: Bearer $TOKEN" -d '{ "synchronizationId": "<synchronizationId returned above>" }' \
  synchro.api.external-integration.ubikap.dev:443 services.synchronization.v1.SynchronizationService/GetSynchroState

Add -max-time 30 to give the call a deadline. The API reference shows a ready-to-edit grpcurl command for every RPC: pick grpcurl in its client list.

Without reflection

Section titled “Without reflection”

To work from the proto files instead, compile them with their dependencies into a descriptor set, and give it to grpcurl:

Terminal window
cd ubikap-synchro-service-proto
buf build -o ubikap-synchro-service.protoset
grpcurl -protoset ubikap-synchro-service.protoset synchro.api.external-integration.ubikap.dev:443 list

Postman

Section titled “Postman”
  1. New › gRPC, and enter synchro.api.external-integration.ubikap.dev:443 as the server URL.
  2. Click the lock icon next to the URL to enable TLS.
  3. In Service definition, choose Using server reflection — or import the .proto files of the archive.
  4. Pick a method, e.g. AuthenticationService / LogIn, and click Generate example message to fill the message as JSON.
  5. For every method but LogIn, open the Metadata tab and add the key authorization with the value Bearer <token>.
  6. Click Invoke. An error shows its status code and message.