Get one integration

curl --request GET \
  --url https://api.chift.eu/integrations/{integrationid} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.chift.eu/integrations/{integrationid}', 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.chift.eu/integrations/{integrationid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.chift.eu/integrations/{integrationid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/integrations/{integrationid}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "integrationid": 123,
  "name": "<string>",
  "status": "active",
  "api": "Point of Sale",
  "logo_url": "<string>",
  "icon_url": "<string>",
  "description": "<string>",
  "post_connections": [],
  "operations_coverage": [],
  "credentials": [],
  "supported_countries": "BE",
  "local_agent": false
}

{
  "message": "The integration does not exist",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

integrations

{integrationid}

Get one integration

curl --request GET \
  --url https://api.chift.eu/integrations/{integrationid} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.chift.eu/integrations/{integrationid}', 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.chift.eu/integrations/{integrationid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.chift.eu/integrations/{integrationid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/integrations/{integrationid}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "integrationid": 123,
  "name": "<string>",
  "status": "active",
  "api": "Point of Sale",
  "logo_url": "<string>",
  "icon_url": "<string>",
  "description": "<string>",
  "post_connections": [],
  "operations_coverage": [],
  "credentials": [],
  "supported_countries": "BE",
  "local_agent": false
}

{
  "message": "The integration does not exist",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

integrationid

integer

required

Query Parameters

include_coverage

enum<string> | null

default:false

Available options:

true,

false

Response

Successful Response

integrationid

integer

required

name

string

required

status

enum<string>

required

Available options:

active,

inactive

api

enum<string>

required

Available options:

Point of Sale,

eCommerce,

Accounting,

Invoicing,

Communication,

Banking,

Custom,

Payment,

Property Management System,

Spend Management

logo_url

string

required

icon_url

string

required

description

string | null

post_connections

IntegrationsPostConnectionItem · object[] | null

List of post-connections that can be activated for this integration.

Show child attributes

operations_coverage

CoverageItem · object[] | null

List of operations coverage for this integration.

Show child attributes

credentials

IntegrationsCredentialItem · object[] | null

List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.

Show child attributes

supported_countries

string[] | null

Country codes (ISO 3166-1 alpha-2) where this integration is supported. If not defined, the integration is supported globally.

Example:

"BE"

local_agent

boolean

default:false

This field indicate if the integration is a local agent.

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Spend Management

Other

Get one integration

Authorizations

Path Parameters

Query Parameters

Response