Configurações · API Hooked

Visão Geral

O módulo Configurações gerencia as configurações fiscais e operacionais de cada empresa no sistema, incluindo séries de notas fiscais, ambiente (produção/homologação), SMTP para envio de e-mails, condições padrão de pagamento e parâmetros de emissão.

Base URL

/api/configuracoes

Todos os endpoints requerem autenticação via Bearer Token:
Authorization: Bearer {token}

Endpoints

GET /api/configuracoes/{empresaId}

Descrição: Retorna as configurações fiscais e operacionais de uma empresa específica.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`empresaId`	integer (int64)	path	✓	ID da empresa

Resposta de Sucesso `200`

{
  "id": 1,
  "empresaId": 1,
  "serie": "1",
  "modelo": "55",
  "numeroAtual": 1042,
  "senhaCertificado": null,
  "cIdToken": null,
  "csc": null,
  "tipoEmissao": 1,
  "tipoAmbiente": 1,
  "servidorSmtp": "smtp.gmail.com",
  "porta": 587,
  "email": "[email protected]",
  "senhaEmail": null,
  "assunto": "NF-e emitida",
  "timeout": 30,
  "assincrono": false,
  "mensagemEmHtml": true,
  "ssl": true,
  "mensagem": "Segue em anexo a NF-e.",
  "ativo": true,
  "padrao": true,
  "codigoPedidoAtual": 500,
  "naturezaOperacaoId": 3,
  "naturezaOperacaoDescricao": "Venda de Mercadoria",
  "atualizarVolumePorProdutoNotaFiscal": null,
  "tipoExibicaoPagamento": null,
  "formaPagamentoId": 1,
  "condicaoPagamentoId": 1,
  "habilitarDIFAL": null,
  "formaPagamentoImportacaoId": null,
  "naturezaOperacaoImportacaoId": null,
  "naturezaOperacaoImportacaoDescricao": null,
  "notaFiscalDescricaoComplementar": null,
  "notaFiscalInformarVendedor": null
}

Campos da Resposta

Campo	Tipo	Obrigatório	Descrição
`id`	integer (int64)	—	Identificador da configuração
`empresaId`	integer (int64)	✓	ID da empresa
`serie`	string	✓	Série da nota fiscal
`modelo`	string	✓	Modelo do documento (`55` = NF-e, `65` = NFC-e)
`numeroAtual`	integer	✓	Número atual da nota fiscal
`tipoEmissao`	integer	✓	Tipo de emissão (`1` = Normal, `6` = Contingência)
`tipoAmbiente`	integer	✓	Ambiente (`1` = Produção, `2` = Homologação)
`servidorSmtp`	string	—	Endereço do servidor SMTP
`porta`	integer	—	Porta do servidor SMTP
`email`	string	—	E-mail remetente
`ssl`	boolean	—	Habilitar SSL no SMTP
`assincrono`	boolean	—	Emissão assíncrona
`mensagemEmHtml`	boolean	—	Mensagem de e-mail em HTML
`ativo`	boolean	—	Configuração ativa
`padrao`	boolean	—	Configuração padrão da empresa
`codigoPedidoAtual`	integer	✓	Número atual de pedidos
`naturezaOperacaoId`	integer (int64)	✓	ID da natureza de operação padrão
`formaPagamentoId`	integer (int64)	✓	ID da forma de pagamento padrão
`condicaoPagamentoId`	integer (int64)	✓	ID da condição de pagamento padrão

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`404`	Configuração não encontrada para a empresa informada
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/configuracoes/{empresaId}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/configuracoes/{empresaId}', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/configuracoes/{empresaId}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/configuracoes/{empresaId}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/configuracoes/{empresaId}');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/configuracoes/{empresaId}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/configuracoes/{empresaId}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

POST /api/configuracoes

Descrição: Cria ou atualiza as configurações fiscais e operacionais de uma empresa.

Corpo da Requisição

{
  "empresaId": 1,
  "serie": "1",
  "modelo": "55",
  "numeroAtual": 1,
  "tipoEmissao": 1,
  "tipoAmbiente": 2,
  "servidorSmtp": "smtp.gmail.com",
  "porta": 587,
  "email": "[email protected]",
  "senhaEmail": "senha",
  "assunto": "NF-e emitida",
  "ssl": true,
  "mensagemEmHtml": true,
  "mensagem": "Segue em anexo a NF-e.",
  "assincrono": false,
  "ativo": true,
  "padrao": true,
  "codigoPedidoAtual": 1,
  "naturezaOperacaoId": 1,
  "formaPagamentoId": 1,
  "condicaoPagamentoId": 1
}

Campo	Tipo	Obrigatório	Descrição
`empresaId`	integer (int64)	✓	ID da empresa
`serie`	string	✓	Série da nota fiscal
`modelo`	string	✓	Modelo do documento (`55` = NF-e, `65` = NFC-e)
`numeroAtual`	integer	✓	Número atual da nota fiscal
`tipoEmissao`	integer	✓	Tipo de emissão (`1` = Normal, `6` = Contingência)
`tipoAmbiente`	integer	✓	Ambiente (`1` = Produção, `2` = Homologação)
`servidorSmtp`	string	—	Endereço do servidor SMTP
`porta`	integer	—	Porta SMTP
`email`	string	—	E-mail remetente
`senhaEmail`	string	—	Senha do e-mail
`ssl`	boolean	—	Habilitar SSL
`naturezaOperacaoId`	integer (int64)	✓	ID da natureza de operação padrão
`formaPagamentoId`	integer (int64)	✓	ID da forma de pagamento padrão
`condicaoPagamentoId`	integer (int64)	✓	ID da condição de pagamento padrão

Resposta de Sucesso `200`

Retorna o objeto de configuração criado/atualizado com a mesma estrutura do GET /api/configuracoes/{empresaId}.

Códigos de Erro

Código	Descrição
`400`	Dados inválidos — campos obrigatórios ausentes
`401`	Token ausente ou inválido
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/configuracoes" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"empresaId":1,"serie":"1","modelo":"55","numeroAtual":1,"tipoEmissao":1,"tipoAmbiente":2,"servidorSmtp":"smtp.gmail.com","porta":587,"email":"[email protected]","senhaEmail":"senha","assunto":"NF-e emitida","ssl":true,"mensagemEmHtml":true,"mensagem":"Segue em anexo a NF-e.","assincrono":false,"ativo":true,"padrao":true,"codigoPedidoAtual":1,"naturezaOperacaoId":1,"formaPagamentoId":1,"condicaoPagamentoId":1}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/configuracoes', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "empresaId": 1,
  "serie": "1",
  "modelo": "55",
  "numeroAtual": 1,
  "tipoEmissao": 1,
  "tipoAmbiente": 2,
  "servidorSmtp": "smtp.gmail.com",
  "porta": 587,
  "email": "[email protected]",
  "senhaEmail": "senha",
  "assunto": "NF-e emitida",
  "ssl": true,
  "mensagemEmHtml": true,
  "mensagem": "Segue em anexo a NF-e.",
  "assincrono": false,
  "ativo": true,
  "padrao": true,
  "codigoPedidoAtual": 1,
  "naturezaOperacaoId": 1,
  "formaPagamentoId": 1,
  "condicaoPagamentoId": 1
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/configuracoes',
    headers={'Authorization': 'Bearer {token}'},
    json={'empresaId': 1, 'serie': '1', 'modelo': '55', 'numeroAtual': 1, 'tipoEmissao': 1, 'tipoAmbiente': 2, 'servidorSmtp': 'smtp.gmail.com', 'porta': 587, 'email': '[email protected]', 'senhaEmail': 'senha', 'assunto': 'NF-e emitida', 'ssl': True, 'mensagemEmHtml': True, 'mensagem': 'Segue em anexo a NF-e.', 'assincrono': False, 'ativo': True, 'padrao': True, 'codigoPedidoAtual': 1, 'naturezaOperacaoId': 1, 'formaPagamentoId': 1, 'condicaoPagamentoId': 1}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"empresaId":1,"serie":"1","modelo":"55","numeroAtual":1,"tipoEmissao":1,"tipoAmbiente":2,"servidorSmtp":"smtp.gmail.com","porta":587,"email":"[email protected]","senhaEmail":"senha","assunto":"NF-e emitida","ssl":true,"mensagemEmHtml":true,"mensagem":"Segue em anexo a NF-e.","assincrono":false,"ativo":true,"padrao":true,"codigoPedidoAtual":1,"naturezaOperacaoId":1,"formaPagamentoId":1,"condicaoPagamentoId":1}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/configuracoes", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/configuracoes');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'empresaId' => 1,
        'serie' => '1',
        'modelo' => '55',
        'numeroAtual' => 1,
        'tipoEmissao' => 1,
        'tipoAmbiente' => 2,
        'servidorSmtp' => 'smtp.gmail.com',
        'porta' => 587,
        'email' => '[email protected]',
        'senhaEmail' => 'senha',
        'assunto' => 'NF-e emitida',
        'ssl' => true,
        'mensagemEmHtml' => true,
        'mensagem' => 'Segue em anexo a NF-e.',
        'assincrono' => false,
        'ativo' => true,
        'padrao' => true,
        'codigoPedidoAtual' => 1,
        'naturezaOperacaoId' => 1,
        'formaPagamentoId' => 1,
        'condicaoPagamentoId' => 1
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/configuracoes",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/configuracoes",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"empresaId\":1,\"serie\":\"1\",\"modelo\":\"55\",\"numeroAtual\":1,\"tipoEmissao\":1,\"tipoAmbiente\":2,\"servidorSmtp\":\"smtp.gmail.com\",\"porta\":587,\"email\":\"[email protected]\",\"senhaEmail\":\"senha\",\"assunto\":\"NF-e emitida\",\"ssl\":true,\"mensagemEmHtml\":true,\"mensagem\":\"Segue em anexo a NF-e.\",\"assincrono\":false,\"ativo\":true,\"padrao\":true,\"codigoPedidoAtual\":1,\"naturezaOperacaoId\":1,\"formaPagamentoId\":1,\"condicaoPagamentoId\":1}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

Visão Geral

Base URL

Endpoints

Parâmetros

Resposta de Sucesso 200

Campos da Resposta

Códigos de Erro

Exemplos de Código

Corpo da Requisição

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Resposta de Sucesso `200`

Resposta de Sucesso `200`