API RPC do Odoo

Visão Geral

O Odoo expõe uma API externa poderosa via JSON-RPC e XML-RPC, permitindo que qualquer aplicação externa leia, crie, atualize e exclua registros. Esta habilidade guiará você pela autenticação, chamadas de modelos e construção de integrações robustas.

Quando Usar Esta Habilidade

• Conectar um aplicativo externo (por exemplo, Django, Node.js, um aplicativo móvel) ao Odoo.
• Executar scripts automatizados para importar/exportar dados do Odoo.
• Construir uma camada de middleware entre o Odoo e uma plataforma de terceiros.
• Depurar erros de autenticação ou permissão da API.

Como Funciona

1. Ativar: Mencione @odoo-rpc-api e descreva a integração que você precisa.
2. Gerar: Obtenha código de chamada RPC pronto para copiar e colar em Python, JavaScript ou curl.
3. Depurar: Cole um erro e obtenha um diagnóstico com uma chamada corrigida.

Exemplos

Exemplo 1: Autenticar e Ler Registros (Python)

import os
import xmlrpc.client

url = 'https://myodoo.example.com'
db = 'my_database'
username = 'admin'
password = os.environ["ODOO_API_KEY"]  # Use API keys, not passwords, in production

# Step 1: Authenticate
common = xmlrpc.client.ServerProxy(f'{url}/xmlrpc/2/common')
uid = common.authenticate(db, username, password, {})
print(f"Authenticated as UID: {uid}")

# Step 2: Call models
models = xmlrpc.client.ServerProxy(f'{url}/xmlrpc/2/object')

# Search confirmed sale orders
orders = models.execute_kw(db, uid, password,
    'sale.order', 'search_read',
    [[['state', '=', 'sale']]],
    {'fields': ['name', 'partner_id', 'amount_total'], 'limit': 10}
)
for order in orders:
    print(order)

Exemplo 2: Criar um Registro (Python)

new_partner_id = models.execute_kw(db, uid, password,
    'res.partner', 'create',
    [{'name': 'Acme Corp', 'email': 'info@acme.com', 'is_company': True}]
)
print(f"Created partner ID: {new_partner_id}")

Exemplo 3: JSON-RPC via curl

curl -X POST https://myodoo.example.com/web/dataset/call_kw \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "method": "call",
    "id": 1,
    "params": {
      "model": "res.partner",
      "method": "search_read",
      "args": [[["is_company", "=", true]]],
      "kwargs": {"fields": ["name", "email"], "limit": 5}
    }
  }'
# Note: "id" is required by the JSON-RPC 2.0 spec to correlate responses.
# Odoo 16+ also supports the /web/dataset/call_kw endpoint but
# prefer /web/dataset/call_kw for model method calls.

Melhores Práticas

• ✅ Faça: Use Chaves de API (Configurações → Técnico → Chaves de API) em vez de senhas — disponível a partir do Odoo 14+.
• ✅ Faça: Use search_read em vez de search + read para reduzir idas e vindas na rede.
• ✅ Faça: Sempre trate erros de conexão e implemente lógica de retentativa com backoff exponencial em produção.
• ✅ Faça: Armazene credenciais em variáveis de ambiente ou em um gerenciador de segredos (por exemplo, AWS Secrets Manager, arquivo .env).
• ❌ Não faça: Codifique senhas ou chaves de API diretamente em scripts — rotacione-as e use variáveis de ambiente.
• ❌ Não faça: Chame a API em um loop apertado sem agrupar — operações em massa reduzem significativamente a carga do servidor.
• ❌ Não faça: Use a senha de administrador mestre para integrações de API — crie um usuário de integração dedicado com as permissões mínimas necessárias.

Limitações

• Não cobre autenticação baseada em OAuth2 ou cookie de sessão — os exemplos usam apenas autenticação por chave de API (token).
• Limitação de taxa não é embutida na camada XMLRPC do Odoo; você deve implementar o throttling no lado do cliente.
• O endpoint XML-RPC (/xmlrpc/2/) não suporta upload de arquivos — use o modelo ir.attachment baseado em REST via JSON-RPC para dados binários.
• Odoo.sh (SaaS) pode bloquear algumas chamadas de API dependendo do plano; verifique se sua assinatura suporta acesso à API externa.