Make a request

Make a request

curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/passthrough \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1234,
  "data": {
    "config_id": "config_123",
    "method": "GET",
    "path": "/v3/company/{realmId}/invoice",
    "params": {
      "page": 1
    },
    "headers": {
      "Content-Type": "application/json"
    },
    "data": {},
    "response_type": "json"
  }
}
'

import requests

url = "https://api.integrations.commenda.io/v4/core/passthrough"

payload = {
    "company_id": 1234,
    "data": {
        "config_id": "config_123",
        "method": "GET",
        "path": "/v3/company/{realmId}/invoice",
        "params": { "page": 1 },
        "headers": { "Content-Type": "application/json" },
        "data": {},
        "response_type": "json"
    }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_id: 1234,
    data: {
      config_id: 'config_123',
      method: 'GET',
      path: '/v3/company/{realmId}/invoice',
      params: {page: 1},
      headers: {'Content-Type': 'application/json'},
      data: {},
      response_type: 'json'
    }
  })
};

fetch('https://api.integrations.commenda.io/v4/core/passthrough', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/passthrough",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_id' => 1234,
    'data' => [
        'config_id' => 'config_123',
        'method' => 'GET',
        'path' => '/v3/company/{realmId}/invoice',
        'params' => [
                'page' => 1
        ],
        'headers' => [
                'Content-Type' => 'application/json'
        ],
        'data' => [
                
        ],
        'response_type' => 'json'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/passthrough"

	payload := strings.NewReader("{\n  \"company_id\": 1234,\n  \"data\": {\n    \"config_id\": \"config_123\",\n    \"method\": \"GET\",\n    \"path\": \"/v3/company/{realmId}/invoice\",\n    \"params\": {\n      \"page\": 1\n    },\n    \"headers\": {\n      \"Content-Type\": \"application/json\"\n    },\n    \"data\": {},\n    \"response_type\": \"json\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.integrations.commenda.io/v4/core/passthrough")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 1234,\n  \"data\": {\n    \"config_id\": \"config_123\",\n    \"method\": \"GET\",\n    \"path\": \"/v3/company/{realmId}/invoice\",\n    \"params\": {\n      \"page\": 1\n    },\n    \"headers\": {\n      \"Content-Type\": \"application/json\"\n    },\n    \"data\": {},\n    \"response_type\": \"json\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/passthrough")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": 1234,\n  \"data\": {\n    \"config_id\": \"config_123\",\n    \"method\": \"GET\",\n    \"path\": \"/v3/company/{realmId}/invoice\",\n    \"params\": {\n      \"page\": 1\n    },\n    \"headers\": {\n      \"Content-Type\": \"application/json\"\n    },\n    \"data\": {},\n    \"response_type\": \"json\"\n  }\n}"

response = http.request(request)
puts response.read_body

{}

POST

core

passthrough

Make a request

curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/passthrough \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1234,
  "data": {
    "config_id": "config_123",
    "method": "GET",
    "path": "/v3/company/{realmId}/invoice",
    "params": {
      "page": 1
    },
    "headers": {
      "Content-Type": "application/json"
    },
    "data": {},
    "response_type": "json"
  }
}
'

import requests

url = "https://api.integrations.commenda.io/v4/core/passthrough"

payload = {
    "company_id": 1234,
    "data": {
        "config_id": "config_123",
        "method": "GET",
        "path": "/v3/company/{realmId}/invoice",
        "params": { "page": 1 },
        "headers": { "Content-Type": "application/json" },
        "data": {},
        "response_type": "json"
    }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_id: 1234,
    data: {
      config_id: 'config_123',
      method: 'GET',
      path: '/v3/company/{realmId}/invoice',
      params: {page: 1},
      headers: {'Content-Type': 'application/json'},
      data: {},
      response_type: 'json'
    }
  })
};

fetch('https://api.integrations.commenda.io/v4/core/passthrough', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/passthrough",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_id' => 1234,
    'data' => [
        'config_id' => 'config_123',
        'method' => 'GET',
        'path' => '/v3/company/{realmId}/invoice',
        'params' => [
                'page' => 1
        ],
        'headers' => [
                'Content-Type' => 'application/json'
        ],
        'data' => [
                
        ],
        'response_type' => 'json'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/passthrough"

	payload := strings.NewReader("{\n  \"company_id\": 1234,\n  \"data\": {\n    \"config_id\": \"config_123\",\n    \"method\": \"GET\",\n    \"path\": \"/v3/company/{realmId}/invoice\",\n    \"params\": {\n      \"page\": 1\n    },\n    \"headers\": {\n      \"Content-Type\": \"application/json\"\n    },\n    \"data\": {},\n    \"response_type\": \"json\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.integrations.commenda.io/v4/core/passthrough")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 1234,\n  \"data\": {\n    \"config_id\": \"config_123\",\n    \"method\": \"GET\",\n    \"path\": \"/v3/company/{realmId}/invoice\",\n    \"params\": {\n      \"page\": 1\n    },\n    \"headers\": {\n      \"Content-Type\": \"application/json\"\n    },\n    \"data\": {},\n    \"response_type\": \"json\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/passthrough")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": 1234,\n  \"data\": {\n    \"config_id\": \"config_123\",\n    \"method\": \"GET\",\n    \"path\": \"/v3/company/{realmId}/invoice\",\n    \"params\": {\n      \"page\": 1\n    },\n    \"headers\": {\n      \"Content-Type\": \"application/json\"\n    },\n    \"data\": {},\n    \"response_type\": \"json\"\n  }\n}"

response = http.request(request)
puts response.read_body

{}

Authorizations

api_key

string

header

required

Your Commenda Integrations API key, sent in the api_key header.

Body

application/json

company_id

number

required

Example:

1234

data

object

required

Show child attributes

Response

200 - application/json

The response is of type object.

Update sync config

Get

General

Server Side SDKs

Core

Unified API

Authorizations

Body

Response