Skip to content

Reference

Each tool takes a JSON object and returns JSON.

Tool	Input	Output	Notes
`platform_v1_HelloService_GetHello`	`GetHelloRequest`	`Hello`	Fetch the sample greeting.
`platform_v1_IdentityService_Signup`	`SignupRequest`	`SignupResponse`
`platform_v1_IdentityService_CreateSession`	`SessionRequest`	`SessionOk`
`platform_v1_IdentityService_DeleteSession`	`Empty`	`Empty`
`platform_v1_IdentityService_GetSession`	`Empty`	`SessionView`
`healthz`	(none)	`ok`	Check that the API is up.

Inputs and outputs

`Empty`

No fields.

`GetHelloRequest`

No fields.

`Hello`

Hello is the sample greeting returned by the template backend.

Field	Type	#	Notes
`message`	`string`	1
`source`	`string`	2	source is “cloud” for the compose apiserver and “local” for local-backend.

`SessionOk`

Field	Type	#	Notes
`ok`	`bool`	1

`SessionRequest`

Field	Type	#	Notes
`email`	`string`	1
`password`	`string`	2
`shop_id`	`string`	3

`SessionView`

Field	Type	#	Notes
`staff`	`Staff`	1
`shop`	`Shop`	2
`organization`	`Organization`	3
`role`	`string`	4

`SignupRequest`

Field	Type	#	Notes
`organization_name`	`string`	1
`shop_name`	`string`	2
`shop_currency`	`string`	3
`owner_email`	`string`	4
`owner_password`	`string`	5
`billing_email`	`string`	6

`SignupResponse`

Field	Type	#	Notes
`organization`	`Organization`	1
`shop`	`Shop`	2
`staff`	`Staff`	3