Recebimento de Fornecedores via API

O sistema valesoft permite a integração de fornecedores externos através de requisição HTTP GET a uma API de um ERP, ou outro sistema externo.

Para o funcionamento correto é necessário configurar o token de acesso e a url da API para integração.

A integração Http Json pode chamar APIs sem autenticação ou com autenticação por meio de token passado no header Authorization, como por exemplo, Basic dXNlcm5hbWU6cGFzc3dvcmQ= ou Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

A consulta ocorre de forma paginada com lotes de 250 registros. Isso ocorre através dos parâmetros pageIndexe pageSize. Exemplo:    GET /api/supplier?pageIndex=0&pageSize=250 ou GET /api/supplier?pageIndex=1&pageSize=500, etc.

Resposta esperada pela integração Http Json

O sistema espera um retorno em formato JSON da seguinte forma:

{
  "items": [
    {
      "id": "453a8f0c-a77a-46bc-80e2-8bc4007c34e9",
      "createdAt": "2024-05-28 14:59:14",
      "createdBy": "valesoft",
      "updatedAt": "2024-05-28 14:59:14",
      "updatedBy": "valesoft",
      "reference":"123/1234",
      "integrated": true,
      "name":"Fornecedor 1",
      "document":"12345678909",
      "externalId": "321",
      "custom": {
        "custom1": "1"
      }
     }
  ],
  "totalItems": 1
}

Aqui está uma descrição de cada campo:

• id - OBRIGATÓRIO

  • Alfanumérico
  • Código Único do fornecedor no sistema

• createdAt

  • Data
  • Data de criação do fornecedor

• createdBy

  • Alfanumérico
  • Usuário responsável pelo cadastro do fornecedor

• updatedAt

  • Data
  • Data da ultima atualização do fornecedor

• updatedBy

  • Alfanumérico
  • Usuário responsável pela ultima edição do fornecedor

• reference - OBRIGATÓRIO

  • Alfanumérico
  • Código Único do fornecedor

• integrated

  • Boolean
  • Identifica se o fornecedor foi cadastrado via integração

• name - OBRIGATÓRIO

  • Texto
  • Nome do fornecedor

• document

  • Numérico
  • CPF/CNPJ Único do fornecedor

• externalId

  • Alfanumérico
  • Código de identificação do fornecedor em sistema externo

• totalItems

  • Número total de fornecedores

Os nomes dos campos da integração podem ser alterados nas configurações caso no sistema externo ou ERP eles forem diferentes.

Ainda é possível receber campos personalizados desde que o mesmo esteja devidamente configurado para a tabela de Fornecedores nas configurações do sistema.

Resposta esperada em caso de erro

Retornar uma resposta padrão HTTP com o respectivo status de erro

{
    "errorMessage": "Mensagem de erro"
}