Listar integrações

GET

/integrations

Para buscar as integrações de um usuário, utilize o método GET na rota /integrations. Este método requer os seguintes parâmetros:

• filter: Filtro para buscar as integrações do usuário

Este método retorna um objeto com os dados das integrações, incluindo:

• id: Identificador único da integração
• gateway: Código identificador da integração (gateway)
• webhook: Indica se a integração possui webhook
• webhookConstraint: Restrição do webhook
• metadata: Metadados da integração

Importante:

• Para buscar as integrações de um usuário, é necessário informar o token de autenticação no cabeçalho da requisição.
• O filtro de busca pode ser utilizado para buscar integrações por código identificador da integração (gateway).
• O campo metadata contém os metadados da integração, um conjunto de informações específicas de chave e valor.

Parâmetros

Parâmetros de Consulta

filter

Campos de definição de filtro, where, include, order, offset, e limit - devem ser uma
string JSON-encoded ({"where":{"something":"value"}}).
Veja https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries
para maiores detalhes.

Tipostring

Respostas

Request was successful

Content-Type

Usar exemplo

[

{

"id": 0,

"gateway": "integration-code",

"webhook": true,

"webhookConstraint": {

},

"metadata": {

}

}

]

GET

/integrations

Exemplos

cURL

curl -X GET \
'https://api.api4com.com/api/v1/integrations' \
 -H "Content-Type: application/json"

JavaScript

fetch('https://api.api4com.com/api/v1/integrations', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'https://api.api4com.com/api/v1/integrations';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'https://api.api4com.com/api/v1/integrations'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())