Introdução à API

A Pilar Collector disponibiliza uma interface de programação web, no modelo REST. Por meio dessa interface, é possível conversar com o sistema da Pilar, comandando ações, verificando configurações e realizando a sincronização com os seus sistemas.

O endereço base de comunicação é pilarcollector.com.br, acompanhado sempre do protocolo seguro https:// como prefixo. As versões da API são agrupadas por diretório, sufixadas ao endereço base (https://pilarcollector.com.br/api/).

Autenticação

A autenticação na Pilar Collector é feita através da utilização de uma chave de API. Esta chave serve para que o sistema identifique a sua conta, e concede permissões para que o sistema se comunique com a pilar em nome da conta em questão.

[POST] https://pilarcollector.com.br/api/v2/obter-token/

Parâmetros:

• usuario (string obrigatório)
• senha (string obrigatório)

Exemplo de chamada (cURL):

  curl --location --request POST 'https://pilarcollector.com.br/api/v2/obter-token/' \
	--header 'Content-Type: application/json' \
	--data-raw '{ \
		"usuario":"exemplo", \
		"senha":"Teste123@", \
		"force":"0" ou "1", \
	}'
					

Exemplo de retorno (JSON):

  {
     "status": true,
     "auth_token": "exemplo::pbkdf2_sha256$24000$HJMs7tozaitE$497y1jWZB515kXt5eGh00pWCULXR7LIPCCNU/W8sk6g=",
  }
  					

Resposta em JSON

A fim de facilitar a interoperabilidade entre sistemas, todas as nossas chamadas de API respondem no formato JSON.

Atualizar Produtos

Importação (automática) de Produtos do sistema do cliente via API.

[POST] https://pilarcollector.com.br/api/v2/atualizar-produtos

Parâmetros:

• auth_token (string obrigatório)
• produtos (array of objects produto_item obrigatório)
• • produto_item:
  • • codigo (string opcional, máximo 20 caracteres)
    • codigo_barras (string obrigatório, máximo 20 caracteres)
    • codigo_barras_alternativo (string opcional, máximo 20 caracteres)
    • embalagem (integer opcional)
    • descricao (string obrigatório, máximo 80 caracteres)
    • custo_unitario (integer opcional)
    • unidade (string opcional, máximo 10 caracteres)
    • secoes (string opcional, máximo 255 caracteres)
    • grupo (string opcional, máximo 40 caracteres)
    • sub_grupo (string opcional, máximo 40 caracteres)
    • familia (string opcional, máximo 60 caracteres)

Exemplo de chamada (cURL):

						
	curl --location --request POST 'https://pilarcollector.com.br/api/v2/atualizar-produtos/' \
	--header 'Content-Type: application/json' \
	--data-raw '{
	  "auth_token": "exemplo::pbkdf2_sha256$24000$HJMs7tozaitE$497y1jWZB515kXt5eGh00pWCULXR7LIPCCNU/W8sk6g=",
	  "produtos": [
	    {
	      "codigo": "42073",
	      "codigo_barras": "7898125081607",
	      "codigo_barras_alternativo": "",
	      "embalagem": "",
	      "descricao": "AIPIM PRE COZIDO SHEKINAH 800 G",
	      "custo_unitario": "4,99",
	      "unidade": "UN",
	      "secoes": "CEREAIS - LOJA;CEREAIS - DEPÓSITO",
	      "grupo": "CEREAIS",
	      "sub_grupo": "CONGELADOS",
	      "familia": "PRE COZIDOS",
	      "ativo": "1"
        },
      ]
    }'

Exemplo de retorno (JSON):

						
	{
	  "status": true,
	  "message": "Produtos atualizados com sucesso."
	}

Atualizar Estoque

Importação (automática) de estoque do sistema do cliente via API.

[POST] https://pilarcollector.com.br/api/v2/atualizar-estoque/

Parâmetros:

• auth_token (string obrigatório)
• opcao_duplicados (string[1] obrigatório)
• • [1]: Ignorar os produtos duplicados
  • [2]: Somar quantidade dos produtos duplicados
  • [3]: Substituir os produtos duplicados
• opcao_erros (string[1] obrigatório)
• • [1]: Ignorar os registros com erro e importar os outros
  • [2]: Não importar nenhum item
• estoque (array of objects estoque_item obrigatório)
• • estoque_item:
  • • codigo (integer obrigatório)
    • codigo_barras (string obrigatório, máximo 20 caracteres)
    • estoque_sistema (decimal obrigatório, exemplo: 896,037)
    • produto_custo_unitario (decimal obrigatório, exemplo: 4,99)

Exemplo de chamada (cURL):

  curl --location --request POST 'https://pilarcollector.com.br/api/v2/atualizar-estoque/' \
  --header 'Content-Type: application/json' \
  --data-raw '{
     "auth_token": "exemplo::pbkdf2_sha256$24000$HJMs7tozaitE$497y1jWZB515kXt5eGh00pWCULXR7LIPCCNU/W8sk6g=",
     "opcao_duplicados": "1", 
     "opcao_erros": "1",
     "estoque": [
        {
        	"codigo": "42073",
        	"codigo_barras": "7898125081607",
        	"estoque_sistema": "896,037",
        	"produto_custo_unitario": "4,99",
        },
        {
        	"codigo": "32866",
        	"codigo_barras": "7898937237049",
        	"estoque_sistema": "26",
        	"produto_custo_unitario": "5,99",
        }
     ]
  }'
	

Exemplo de retorno (JSON):

{
    "status": true,
    "message": "Estoque importado com sucesso."
}