Ga naar inhoud
buildinglinksbuildinglinks

Create an offer

POST
/api/v1/offers
curl --request POST \
  --url https://example.com/api/v1/offers \
  --header 'Content-Type: application/json' \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E \
  --data '{ "id": "example", "asset_id": "example", "access_policy_id": "example", "contract_policy_id": "example", "approval": "automatic" }'

Puts a product in the catalog under an access policy (who sees it) and a contract policy (the conditions of the agreement).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

An offer as it is created or changed.

object
id

Left out: one is made.

string | null
asset_id
required
string
access_policy_id
required
string
contract_policy_id
required
string
approval
One of:
null

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

An offer: a product with the policies under which it is in the catalog.

object
id
required
string
asset_id
required

The product.

string
access_policy_id
required

Who sees the offer in the catalog.

string
contract_policy_id
required

The conditions of the agreement.

string
approval

Whether a provider operator must approve each contract request.

string
Allowed values: automatic manual
created_at
string format: date-time

Example 

{
  "approval": "automatic"
}

400

Section titled “400”

Unknown product or policy, or automatic approval of steering.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}