REST API v2.5 SYSTEM OPERATIONAL

Documentação REST API

Bem-vindo ao Hub de Documentação de APIs TF. Aqui você encontra referências completas para consumo das APIs de TF ERP, TF Loja, TF Talk, TF Softwares e outras soluções do grupo. Consulte endpoints, métodos HTTP, autenticação, parâmetros e exemplos de requisições em um único lugar.

Começar Integração

business_center

TF ERP API

Enterprise Resource Planning

Integre módulos financeiros, contábeis e administrativos. A API TF ERP permite a sincronização de dados mestre, lançamentos contábeis e gestão de fluxo de caixa centralizada.

Base URL (Produção)

https://api.tferp.com/v3

Autenticação

OAuth2 Bearer Token

GET /financial/cash-flow

Consultar Fluxo de Caixa

Parâmetros (Query)

Campo	Tipo	Desc
start_date	date	Início do período
end_date	date	Fim do período

Exemplo de Resposta

{
  "balance": 150000.00,
  "entries": [
    { "date": "2023-11-01", "amount": 5000.00, "type": "credit" },
    { "date": "2023-11-02", "amount": -1200.00, "type": "debit" }
  ]
}

storefront

TF Loja API

E-commerce & Digital Storefront

Gerencie catálogos, controle inventário em tempo real e processe pedidos de forma segura. A API TF Loja é o coração das operações de varejo do ecossistema.

Base URL (Produção)

https://api.tfloja.com/v1

Limites (Rate Limit)

1000 req/min (Standard)

Principais Endpoints

GET /products

Listar Produtos do Catálogo

Parâmetros (Query)

Campo	Tipo	Desc
page	int	Paginação
category	string	Filtro ID

Exemplo de Resposta

{
  "data": [
    {
      "id": "prod_8x92nm",
      "name": "TF Smart Watch",
      "price": 299.90,
      "stock": 45
    }
  ]
}

POST /orders

Criar Novo Pedido

Requer autenticação OAuth2 com escopo orders:write.

Payload JSON

{
  "customer_id": "cus_99aa88",
  "items": [
    { "product_id": "prod_8x92nm", "quantity": 1 }
  ],
  "payment_method": "credit_card"
}

chat_bubble

TF Talk API

Communication & Chatbot

Plataforma de comunicação unificada. Envie mensagens via WhatsApp, SMS ou E-mail e integre chatbots inteligentes ao seu atendimento.

Base URL

https://api.tftalk.com/v2

Webhooks

Supported (Signature Verification)

POST /messages/send

Enviar Mensagem

Payload Request

{
  "channel": "whatsapp",
  "recipient": "+5511999998888",
  "content": {
    "type": "text",
    "body": "Olá! Seu pedido foi confirmado."
  }
}

Response (200 OK)

{
  "message_id": "msg_9921828",
  "status": "queued"
}

local_shipping

TF OMS API

Order Management System

Sistema de Gerenciamento de Pedidos completo. Orquestre pedidos de múltiplos canais (omnichannel), gerencie logística e logística reversa.

Base URL

https://api.tfoms.com/v1

Headers

X-Tenant-ID Obrigatório

PUT /orders/{id}/status

Atualizar Status do Pedido

Atualiza o status de processamento de um pedido específico no fluxo de fulfillment.

Parâmetros (Path)

string

UUID do Pedido

Payload Request

{
  "status": "shipped",
  "tracking_code": "BR123456789TR",
  "carrier": "Correios"
}

dns

TF Softwares API

SaaS Management & Licensing

API dedicada à gestão de licenças de software, controle de versionamento e distribuição de updates para produtos SaaS do grupo.

Base URL

https://api.tfsoftwares.com/v2

Autenticação

API Key (Header: X-TF-Key)

POST /licenses/verify

Verificar Validade da Licença

Headers Obrigatórios

Content-Type application/json
X-TF-Key sua_api_key

Payload Request

{
  "license_key": "XXXX-YYYY-ZZZZ",
  "machine_id": "hw_82738273",
  "product_code": "tf_crm_v1"
}

storefront

TF Shop API

E-commerce & Order Management

API dedicada à gestão de lojas virtuais, pedidos, pagamentos e produtos. Permite criar pedidos, consultar status de compras e integrar sistemas externos ao ecossistema TF Shop.

Base URL

https://api.tfshop.com/v1

Autenticação

API Key (Header: X-TF-Key)

POST /orders/create

Criar Novo Pedido

Headers Obrigatórios

Content-Type application/json
X-TF-Key sua_api_key

Payload Request

{
  "customer_id": "cus_392018",
  "items": [
    {
      "product_id": "prd_001",
      "quantity": 2
    }
  ],
  "payment_method": "card",
  "currency": "AOA"
}

warehouse

TF WMS API

Warehouse & Inventory Management

API voltada para gestão de armazéns e controle de inventário. Permite registrar entradas e saídas de produtos, acompanhar o stock em tempo real e consultar relatórios logísticos detalhados.

Base URL

https://api.tfwms.com/v1

Ambiente Sandbox

https://sandbox.api.tfwms.com/v1

POST /inventory/entries

Registrar Entrada de Produtos no Armazém

Status Responses: 201 Created 400 Bad Request

{
  "message": "Product entry registered successfully.",
  "entry_id": "ent_98451234",
  "warehouse_id": "wh_0021",
  "created_at": "2025-01-12T10:45:00Z"
}

account_balance

TF Fiscal API

Tax Calculation & Invoicing

Motor de cálculo tributário e emissão de notas fiscais eletrônicas. Suporta cálculo de ICMS, IPI, PIS/COFINS e regras fiscais complexas para múltiplos estados.

Base URL

https://api.tffiscal.com/v1

Certificado Digital

Requer certificado A1 válido

POST /taxes/calculate

Cálculo Simulado de Impostos

Erro Comum (422 Unprocessable)

Code: invalid_ncm

O código NCM informado não é válido para a operação.

Payload Request

{
  "operation": "sale",
  "destination_state": "SP",
  "products": [
    { "price": 100.00, "ncm": "85176277" }
  ]
}