Accept the agreement

POST

api

distribution

license

curl --request POST \
  --url https://dev.simforge.ai/api/v1/distribution/license/accept \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agreementVersion": "<string>",
  "agreementSha256": "<string>"
}
'

import requests

url = "https://dev.simforge.ai/api/v1/distribution/license/accept"

payload = {
    "agreementVersion": "<string>",
    "agreementSha256": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agreementVersion: '<string>', agreementSha256: '<string>'})
};

fetch('https://dev.simforge.ai/api/v1/distribution/license/accept', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "schema": "simforge.distribution-acceptance/v1",
  "agreementVersion": "<string>",
  "agreementSha256": "<string>",
  "acceptedAt": "<string>"
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Body

application/json

agreementVersion

string

required

Required string length: 1 - 128

agreementSha256

string

required

Pattern: ^[a-f0-9]{64}$

Response

Recorded acceptance.

schema

enum<string>

required

Available options:

simforge.distribution-acceptance/v1

agreementVersion

string

required

agreementSha256

string

required

Pattern: ^[a-f0-9]{64}$

acceptedAt

string

required

Accept the agreement

curl --request POST \
  --url https://dev.simforge.ai/api/v1/distribution/license/accept \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agreementVersion": "<string>",
  "agreementSha256": "<string>"
}
'

import requests

url = "https://dev.simforge.ai/api/v1/distribution/license/accept"

payload = {
    "agreementVersion": "<string>",
    "agreementSha256": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agreementVersion: '<string>', agreementSha256: '<string>'})
};

fetch('https://dev.simforge.ai/api/v1/distribution/license/accept', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "schema": "simforge.distribution-acceptance/v1",
  "agreementVersion": "<string>",
  "agreementSha256": "<string>",
  "acceptedAt": "<string>"
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Cloud API

Endpoints

Accept the agreement

Authorizations

Body

Response