API – Validação dos Campos para Integração

Olá Licitante, como podemos ajudar você?
Imprimir

API – Validação dos Campos para Integração

Ao enviar uma licitação via API, se algum campo obrigatório estiver ausente ou com formato incorreto, uma mensagem de erro indicará qual campo não foi preenchido, facilitando a análise para o desenvolvedor responsável pela integração.

Acesso aos endpoints

Para visualizar os campos obrigatórios de cada endpoint, faça o seguinte caminho:

  • Acesse o Swagger: https://mdw.minha.effecti.com.br/api-integracao/swagger#
  • Encontre o endpoint do portal desejado.
  • Clique no endpoint e, em seguida, em “Schema” para ver os parâmetros esperados.
  • No Schema, você poderá identificar todos os campos obrigatórios para a integração.

 

É importante destacar que, dentro de cada schema, também é possível visualizar o tipo de dado esperado para cada parâmetro do endpoint.

Exemplos de validação

Por exemplo, se o campo da empresa for preenchido com o valor de uma empresa inexistente, será retornado um erro informando a razão da falha.

 

Neste segundo exemplo, se o campo obrigatório “uasgNome” não for preenchido, um erro será retornado indicando a ausência desse campo.