Criar Integração

Integração é algo para que

As integrações (webhooks) precisam

Pontos importantes:

• O usuario e senha são o que a API da global vai utilizar para se comunicar com os clientes (salvo na API dos clientes e com as permissões para que consiga chamar os webhooks necessarios.

• Dentro da global fazemos as criptogafrias para manter as chaves seguras.

• Além da autenticação por bearer token (feito pela integração de autenticação) é imporatnte liberar o IP.

post

Body

application/json

usuariostringRequired

Usuário para autenticação na integração

Example: user

senhastringRequired

Senha para autenticação na integração

Example: password123

urlAutenticacaostringRequired

URL da API da integração

Example: https://api.example.com/auth/login

clienteLegadonumberOptional

Id da company no banco legado

Example: 1

baasClienteLegadonumberOptional

Id da company no banco legado

Example: 1

Responses

default

application/json

post

/integracao

HTTPcURLJavaScriptPython

POST /integracao HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "usuario": "user",
  "senha": "password123",
  "urlAutenticacao": "https://api.example.com/auth/login",
  "clienteLegado": 1,
  "baasClienteLegado": 1
}

default

{
  "id": "e7d3c6c4-3b6d-4e7a-9eae-64c93f9f7f4f",
  "usuario": "user",
  "senha": "password123",
  "urlAutenticacao": "https://api.example.com/auth/login",
  "clienteLegado": 1,
  "baasClienteLegado": 1,
  "urls": [
    {
      "id": "e7d3c6c4-3b6d-4e7a-9eae-64c93f9f7f4f",
      "url": "https://api.example.com/auth/login",
      "tipoUrl": "BLOQUEAR_SALDO"
    }
  ],
  "createdAt": "2023-01-01 00:00:00.000000",
  "updatedAt": "2023-01-01 00:00:00.000000",
  "deleteAt": null
}