15 - API Pública Sisjud

manual – api pública sisjud v1 este manual descreve a api pública do sisjud para integração de sistemas externos (erps, portais, automações) a api é autenticada por chave (api key) e expõe os principais recursos do escritório clientes, casos, tarefas, boletos, prospecção, cobrança e negociações índice 1\ visão geral versão v1 base url https //app sisjud com br/api/v1/ autenticação header x api key ou authorization bearer com a chave gerada no sisjud formato json (request e response) cors habilitado para origem a chave é vinculada ao escritório todas as requisições retornam ou alteram apenas dados desse escritório como obter a chave no sisjud, acesse configurações (menu do escritório) → aba api pública → criar chave informe um nome (ex "sistema erp") e copie a chave exibida uma única vez guarde em local seguro; não é possível recuperá la depois 2\ autenticação envie a chave em um dos formatos abaixo opção a – header x api key get /api/v1/clientes http/1 1 host app sisjud com br x api key sk live xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx content type application/json opção b – authorization bearer get /api/v1/clientes http/1 1 host app sisjud com br authorization bearer sk live xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx content type application/json chave inválida ou inativa a api responde com http 401 e corpo { "error" "unauthorized", "message" "chave inválida ou inativa " } 3\ url base e formato base https //app sisjud com br/api/v1/ recurso no path por exemplo clientes , casos , tarefas , boletos , usuarios , prospeccao , cobranca , negociacoes formas de chamada path get /api/v1/clientes (quando o servidor repassa o path) query get /api/v1/index php?url=clientes (sempre válido) sub recursos e ids alguns recursos usam segundo segmento /api/v1/cobranca/boletos , /api/v1/cobranca/calculos para um único item /api/v1/casos/123 ou ?url=casos/123 ou ?url=casos\&id=123 (conforme implementação do servidor) body em post/put, envie json com content type application/json no recurso prospecção (leads/kanban), as operações em post aceitam também application/x www form urlencoded ; para criar lead ( op=create ), o uso de form urlencoded é recomendado 4\ recursos e endpoints recurso métodos descrição clientes get, post, put, delete crud de clientes do escritório usuarios get, post, put, delete crud de usuários do escritório casos get, post, put, delete crud de casos tarefas get, post, put, delete crud de tarefas boletos get, post, put, delete crud de boletos prospeccao get, post leads e kanban (parâmetro op ) cobranca get listagem de boletos e cálculos negociacoes get listagem de parcelamentos e detalhe com parcelas 4 1 clientes método url / parâmetros descrição get /api/v1/clientes lista todos os clientes do escritório get /api/v1/clientes?id=123 cliente por id (se suportado) post /api/v1/clientes cria cliente (body nomecompleto, cpf, email, etc ) put /api/v1/clientes atualiza cliente (body id, nomecompleto, cpf, celular, email) delete /api/v1/clientes remove cliente (body id) campos principais (post) nomecompleto (obrigatório), cpf (obrigatório, 11 ou 14 dígitos), email , celular , nomefantasia , cnpj , endereco , bairro , cidade , estado , cep , telresidencial , telcomercial 4 2 usuários método url descrição get /api/v1/usuarios lista usuários do escritório post /api/v1/usuarios cria usuário put /api/v1/usuarios atualiza usuário delete /api/v1/usuarios remove usuário consulte o modelo/controller para campos exatos (nome, email, senha, telefone, cpf, cargo, nivel acesso, escritorio) 4 3 casos método url descrição get /api/v1/casos lista casos do escritório get /api/v1/casos?cliente id=5 casos de um cliente get /api/v1/casos/123 ou ?id=123 um caso por id post /api/v1/casos cria caso put /api/v1/casos atualiza caso (id no body ou path) delete /api/v1/casos remove caso campos principais idcliente, idescritorio, tipocaso, parteadversa, numcnj, numprocesso, posicaocliente, areaatuacao, assunto, localtramite, comarca, valorcausa, datadistribuicao, observacao, enderecodev, telfixodev, telceldev, cpf, etc 4 4 tarefas método url descrição get /api/v1/tarefas lista tarefas do escritório get /api/v1/tarefas?id=123 uma tarefa por id post /api/v1/tarefas cria tarefa put /api/v1/tarefas atualiza tarefa delete /api/v1/tarefas remove tarefa campos típicos idcliente, idescritorio, titulo, descricao, prazo, status 4 5 boletos método url descrição get /api/v1/boletos lista boletos get /api/v1/boletos?id=123 boleto por id post /api/v1/boletos cria boleto (idcliente, valor, vencimento, etc ) put /api/v1/boletos atualiza boleto delete /api/v1/boletos remove boleto 4 6 prospecção todas as chamadas usam o parâmetro op (get ou post) base /api/v1/prospeccao ou /api/v1/prospecao op método descrição list get lista leads (filtros status, responsavel id, busca) get get detalhe de um lead ( id ) create post cria lead (nome, telefone, email, cpf cnpj, origem, observacoes, etc ) update post atualiza lead (id + campos) kanban colunas get lista colunas do kanban kanban list get colunas e cards do kanban (filtro busca) kanban move post move card (id, coluna) kanban coluna save post cria/atualiza coluna (id, nome, slug, ordem) kanban colunas ordem post atualiza ordem das colunas (ordem array de ids) kanban coluna apagar post remove coluna (id) kanban gatilhos get lista gatilhos (id coluna opcional) kanban gatilho save post cria/atualiza gatilho kanban gatilho apagar post remove gatilho (id) tags list get lista tags do escritório tags create post cria tag (nome, cor) tags update post atualiza tag (id, nome, cor) tags delete post remove tag (id) lead tags update post adiciona/remove tag do lead (idlead, idtag, action=add|remove) comentarios list get comentários de um lead (id) comentario add post adiciona comentário (id, comentario, mencoes) comentario apagar post remove comentário (id do comentário) anexos list get lista anexos do lead (id) anexo upload post envia anexo (id do lead + arquivo em multipart) anexo apagar post remove anexo (id do anexo) busca cliente get busca cliente por cpf cnpj (query cpf cnpj) lead converter completo post converte lead em cliente e caso (lead id, id gatilho + dados cliente/caso) criar lead ( op=create ) envie op=create na query ou no body campos aceitos nome , telefone , email , cpf cnpj (11 ou 14 dígitos), origem , observacoes , responsavel id , status kanban (slug da coluna; se omitido, usa a primeira coluna do kanban) resposta de sucesso {"success" true, "message" "lead criado", "id" \<id>, "idcliente vinculado" \<id ou null>} se cpf cnpj for enviado e já existir cliente com esse cpf/cnpj no escritório, o lead é criado já vinculado a esse cliente exemplos de url get /api/v1/prospeccao?op=list get /api/v1/prospeccao?op=get\&id=10 post /api/v1/prospeccao com body ou form op=kanban move\&id=10\&coluna=fechamento 4 7 cobrança apenas get sub recurso no path ou em url cobranca ou cobranca/boletos ou cobranca/calculos sub recurso url query (opcional) descrição boletos /api/v1/cobranca ou /api/v1/cobranca/boletos idcliente, idcaso, pago (0/1), limit lista boletos (boletos dados) cálculos /api/v1/cobranca/calculos idcaso lista cálculos do escritório exemplo get /api/v1/cobranca/boletos?idcaso=5\&pago=0 4 8 negociações apenas get lista parcelamentos ou detalhe de um parcelamento (com parcelas) chamada url query descrição listar /api/v1/negociacoes idcaso lista parcelamentos detalhe /api/v1/negociacoes?id=123 ou path /negociacoes/123 id um parcelamento com array parcelas exemplo get /api/v1/negociacoes?idcaso=10 get /api/v1/negociacoes?id=45 5\ exemplos por recurso listar clientes get /api/v1/clientes http/1 1 host app sisjud com br x api key sk live sua chave aqui content type application/json criar cliente post /api/v1/clientes http/1 1 host app sisjud com br x api key sk live sua chave aqui content type application/json { "nomecompleto" "maria silva", "cpf" "12345678901", "email" "maria\@email com", "celular" "11999998888" } listar leads (prospecção) get /api/v1/prospeccao?op=list http/1 1 host app sisjud com br x api key sk live sua chave aqui kanban da prospecção get /api/v1/prospeccao?op=kanban list http/1 1 host app sisjud com br x api key sk live sua chave aqui criar lead (prospecção) post /api/v1/prospeccao?op=create http/1 1 host app sisjud com br x api key sk live sua chave aqui content type application/x www form urlencoded nome=joão silva\&telefone=11999998888\&email=joao\@email com\&cpf cnpj=12345678901\&origem=site\&observacoes=lead vindo do formulário resposta de sucesso (200) { "success" true, "message" "lead criado", "id" 42, "idcliente vinculado" null } cobrança – boletos em aberto get /api/v1/cobranca/boletos?pago=0 http/1 1 host app sisjud com br x api key sk live sua chave aqui negociações de um caso get /api/v1/negociacoes?idcaso=12 http/1 1 host app sisjud com br x api key sk live sua chave aqui 6\ códigos de resposta e erros código significado 200 sucesso (get, put, delete ou post com retorno de dados) 201 recurso criado (post) 400 dados inválidos ou incompletos 401 chave ausente, inválida ou inativa 404 recurso ou endpoint não encontrado 405 método não permitido para o recurso 500 erro interno do servidor respostas de erro em json costumam seguir o formato { "error" "unauthorized", "message" "chave inválida ou inativa " } ou { "message" "os campos 'nomecompleto' e 'cpf' são obrigatórios " } 7\ postman / insomnia foi disponibilizada uma postman collection com todos os endpoints da api v1 e variáveis para url base e chave arquivo api/postman/sisjud api v1 postman collection json uso no postman import → upload files → selecione o json variáveis da collection base url ex https //app sisjud com br (sem barra no final) api key sua chave (ex sk live ) a collection inclui pastas por recurso (clientes, casos, tarefas, boletos, usuários, prospecção, cobrança, negociações) e requisições de exemplo ajuste base url e api key no nível da collection ou em environment para usar em todos os requests manual sisjud – api pública v1