Chamadas de métodos por mensagens
O JSON-RPC é um protocolo de chamada de procedimento remoto: o cliente envia uma mensagem em JSON com o nome de um método para o servidor executar. Os parâmetros acompanham a chamada quando necessários. Na versão 2.0, o campo jsonrpc deve conter a string "2.0".
Uma soma no JSON-RPC 2.0
Neste exemplo didático, a aplicação oferece o método somar, que recebe dois números por posição:
{ "jsonrpc": "2.0", "method": "somar", "params": [8, 4], "id": 7}Se o servidor oferece esse método e executa a soma com sucesso, a resposta contém o resultado:
{ "jsonrpc": "2.0", "result": 12, "id": 7}A resposta contém a soma em result e repete o id recebido para associar o resultado à requisição. O método somar foi definido para este exemplo e precisa ser implementado pela aplicação que recebe a chamada.
Erros, notificações e transporte
Quando uma chamada falha, a resposta contém error no lugar de result. O objeto de erro informa um código e uma mensagem. Você precisa examiná-lo para distinguir uma execução bem-sucedida de uma mensagem que chegou ao servidor, mas foi recusada.
Uma notificação omite o id e não recebe resposta, inclusive em caso de erro. A ausência de resposta, portanto, não comprova sucesso. A aplicação também escolhe como transportar as mensagens, pois o JSON-RPC não exige HTTP.
Dúvidas frequentes
Perguntas frequentes sobre JSON-RPC
- O JSON-RPC exige HTTP?
- O protocolo permite transportes diferentes, entre eles o HTTP. A aplicação deve definir como enviar e receber as mensagens.
- O que acontece quando o método não existe?
- No JSON-RPC 2.0, o servidor retorna error com o código -32601. Essa resposta não deve incluir result.
- Uma notificação recebe confirmação?
- O servidor não deve responder a uma notificação, que omite o id. Por isso, o cliente não recebe confirmação de sucesso nem os erros dessa execução pelo JSON-RPC.
Para continuar
Recursos relacionados
Documentação
JSON-RPC: especificação 2.0
Define requisições, respostas de sucesso, objetos de erro e notificações do JSON-RPC 2.0.
Abrir recursoSite de referência
DevSide: desenvolvimento colaborativo
Orientação técnica ao vivo para investigar chamadas JSON-RPC e interpretar as respostas de uma integração.
Abrir recursoAplicação na formação
Vibe Coding: Do Zero ao MVP
Nas integrações desenvolvidas com agentes, você pode conferir o método enviado e comparar o id da resposta com o da requisição.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.