Create protocol

POST

https://xtz.nownodes.io/injection/protocol

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Inject a protocol in node. Returns the ID of the protocol. If ?async is true, the function returns immediately. Otherwise, the protocol will be validated before the result is returned.

Body

application/json

Request payload.

The environment a protocol relies on and the components a protocol is made of.

expected_env_versioninteger[0, 65535]required

Expected env version value.

componentsArray<object>required

List of components.

Show child attributes

namestring | objectrequired

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

interfacestring | object

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

implementationstring | objectrequired

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

Parameters

asyncstringquery

Async parameter.

Response

200OK

Successful response.

400Bad Request

Invalid request.

default

Error response.

Create protocol

curl -X POST 'https://xtz.nownodes.io/injection/protocol' \
  -H 'Content-Type: application/json' \
  -d '{
    "expected_env_version": 0,
    "components": [
      {
        "name": "string",
        "implementation": "string"
      }
    ]
  }'

const response = await fetch('https://xtz.nownodes.io/injection/protocol', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "expected_env_version": 0,
      "components": [
        {
          "name": "string",
          "implementation": "string"
        }
      ]
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://xtz.nownodes.io/injection/protocol')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "expected_env_version": 0,
    "components": [
      {
        "name": "string",
        "implementation": "string"
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "expected_env_version": 0,
  "components": [
    {
      "name": "string",
      "implementation": "string"
    }
  ]
}

response = requests.post('https://xtz.nownodes.io/injection/protocol', json=payload)
data = response.json()

const response = await fetch('https://xtz.nownodes.io/injection/protocol', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "expected_env_version": 0,
      "components": [
        {
          "name": "string",
          "implementation": "string"
        }
      ]
    }),
});

const data = await response.json();

const endpoint = "https://xtz.nownodes.io/injection/protocol";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "expected_env_version": 0,
    "components": [
      {
        "name": "string",
        "implementation": "string"
      }
    ]
  });
console.log(result);

const response = await fetch('https://xtz.nownodes.io/injection/protocol', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "expected_env_version": 0,
      "components": [
        {
          "name": "string",
          "implementation": "string"
        }
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "expected_env_version": 0,
  "components": [
    {
      "name": "string",
      "implementation": "string"
    }
  ]
}

response = requests.post('https://xtz.nownodes.io/injection/protocol', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://xtz.nownodes.io/injection/protocol')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "expected_env_version": 0,
    "components": [
      {
        "name": "string",
        "implementation": "string"
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "expected_env_version": 0,
  "components": [
    {
      "name": "string",
      "implementation": "string"
    }
  ]
}

"string"

{
  "error": "Invalid request parameters."
}

"string"