Brizo v0.3.5past versions

Brizo is the technical component executed by Publishers allowing them to provide extended data services. When running with our Docker images, it is exposed under http://localhost:8030.

/services/access/initialize

post

Initialize the service agreement between the publisher and the consumer.

Parameters

body*

Service agreement initialization.

{
"consumerAddress": "0x00a329c0648769A73afAc7F9381E08FB43dBEA72",
"did": "did:op:08a429b8529856d59867503f8056903a680935a76950bb9649785cc97869a43d",
"serviceAgreementId": "bb23s87856d59867503f80a690357406857698570b964ac8dcc9d86da4ada010",
"serviceDefinitionId": "0",
"signature": "cade376598342cdae231321a0097876aeda656a567a67c6767fd8710129a9dc1",
}

Responses

201 Service agreement successfully initialized.
400 One of the required attributes is missing.
401 Error executing the service agreement.
422 Ocean DID not found on chain.
500 Error

/services/consume

get

Allows download of asset data file.

Parameters

consumerAddress*string

The consumer address.

serviceAgreementId*string

The ID of the service agreement.

url*string

This URL is only valid if Brizo acts as a proxy. Consumer can't download using the URL if it's not through Brizo.

Responses

200 Redirect to valid asset url.
400 One of the required attributes is missing.
401 Invalid asset data.
500 Error