Linha Microsiga Protheus

Árvore de páginas

CONTEÚDO

  1. Visão Geral
  2. Configurações INI
  3. Verbos
  4. Path Param
  5. Exemplos de Jsons de Resposta

01. VISÃO GERAL

A API BeneficiaryElegibility/photo tem como objetivo gravar a foto do beneficiário no cadastro de vidas do SIGAPLS. 

02. CONFIGURAÇÕES INI

Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:

Configuração do REST Protheus

Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> +  /totvsHealthPlans/v1/beneficiaryElegibility/photo.

Exemplo:

Logo, a minha URL será: http://localhost:8080/rest/totvsHealthPlans/v1/beneficiaryElegibility/photo

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo

Path

Descrição

POST/BeneficiaryElegibility/photoGrava a foto do beneficiário no cadastro de vidas do SIGAPLS

04. Corpo da Requisição

O formato do corpo da requisição é form-data e deve-se enviar obrigatoriamente as seguintes chaves:

Campo

Tipo

Descrição

filesFileImagem do beneficiário (binário)
dataTextCódigo da vida (BTS_MATVID)


Exemplo de chamada:

http://localhost:8080/rest/totvsHealthPlans/v1/beneficiaryElegibility/photo


05. EXEMPLOS DE JSONS DE RESPOSTA


Sucesso 200



{
    "base64BenefImage": "base64 da imagem"
}


Erro 400

1
2
3
4

{
    "code": 400,
    "message": "Corpo da requisição inválido!",
    "detailedMessage": "Obrigatórios: 'files' e 'data'"
}