Consumo de APIs

O Swagger de documentação das APIs Valesoft podem ser encontradas acessado o seguinte link:

http://SERVER:8081/swagger-ui/index.html

Onde SERVER é o IP ou DNS do servidor onde o sistema Valesoft está instalado e 8081 a porta definida na instalação.

A chamadas das APIs é possível através de requisições HTTP utilizando autenticação do tipo Basic com credenciais de um usuário devidamente cadastrado no sistema Valesoft.

Ex: Usuário integração com senha 12345678 => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Exemplo de consumo em Javascript da API de listagem paginada de movimentações Valesoft

Parâmetros:

type=IN - Define o filtro de movimentações do tipo entrada

type=OUT - Define o filtro de movimentações do tipo saída

pageIndex=0 - Define a página atual a ser consultada(Sendo a primeira página o valor 0)

pageSize=1 - Define a quantidade de registros a serem retornados por página

orderFields=createdAt -> Define a ordenação dos registro por data de criação

orderDesc=true - Define a ordenação de forma decrescente

fetch(
    "http://SERVER:8081/api/movimentation?type=IN&type=OUT&pageIndex=0&pageSize=1&orderFields=createdAt&orderDesc=true", {
    method: 'GET',
    headers: new Headers({
        "Authorization": "Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4",
        "Content-Type": "application/json",
    }),
})
.then((response) => response.json())
.then(json => console.log(json))
.catch(error => console.log(error));

Exemplo de JSON de resposta:

    {
        "items": [
            {
                "id": "cbb1ddd2-2e19-4f0b-993c-b67994c98980",
                "createdAt": "2023-07-20 16:11:47",
                "createdBy": "valesoft",
                "updatedAt": "2023-07-20 16:11:47",
                "updatedBy": "valesoft",
                "type": "IN",
                "epc": {
                    "id": "0e5e90fd-f4f3-47c8-864c-dabee1d92e21",
                    "createdAt": "2023-07-20 13:03:55",
                    "createdBy": "systemAction",
                    "updatedAt": "2023-07-20 16:11:47",
                    "updatedBy": "valesoft",
                    "custom": {},
                    "integrated": false,
                    "epc": "021981520001760000004139",
                    "productReference": {
                        "id": "b12b4832-170e-436c-af9c-b6669bc6d7ce",
                        "createdAt": "2023-06-30 09:33:02",
                        "createdBy": "valesoft",
                        "updatedAt": "2023-06-30 09:33:02",
                        "updatedBy": "valesoft",
                        "product": {
                            "id": "83c941cb-2e88-4240-a02a-7ac7ff24ddb7",
                            "createdAt": "2023-06-30 09:33:02",
                            "createdBy": "valesoft",
                            "updatedAt": "2023-07-20 13:03:40",
                            "updatedBy": "valesoft",
                            "custom": null,
                            "integrated": false,
                            "sku": "123",
                            "description": "dfg",
                            "barcode": null,
                            "measureUnit": null,
                            "fraction": null,
                            "type": "PRODUCED",
                            "place": null,
                            "externalId": null
                        },
                        "productGrid": null,
                        "sku": "123",
                        "barcode": null,
                        "color": null,
                        "size": null,
                        "measureUnit": null,
                        "fraction": null,
                        "description": "123 - dfg"
                    },
                    "type": "UNIT",
                    "place": {
                        "id": "7470f61a-6262-48d7-af81-a3ee4a4f8357",
                        "createdAt": "2023-04-14 13:27:40",
                        "createdBy": "systemAction",
                        "updatedAt": "2023-04-14 13:27:40",
                        "updatedBy": "systemAction",
                        "custom": null,
                        "integrated": true,
                        "reference": "80",
                        "name": "EXPEDIÇÃO",
                        "address": null,
                        "localization": null,
                        "externalId": "80",
                        "type": "SECTOR"
                    },
                    "status": "ACTIVE",
                    "fraction": null,
                    "virtual": false,
                    "batch": null
        ],
        "totalItems": 2764
    }