VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/PDV e terminal de balcão

Nomes alternativos do login

Os endereços wk_pos_login e wkposlogin, que fazem exatamente o mesmo que pos_login, para os terminais instalados.

Os terminais antigos chamam o login por wk_pos_login (nome da Venddor 1.0) ou wkposlogin (nome do app, sem sublinhado). Todos os endereços desta página executam o mesmo código de Login do caixa: mesmos campos, mesma resposta, mesmos erros. Eles continuam no ar para que nenhum terminal instalado precise ser atualizado. Em software novo use pos_login.

As credenciais do terminal (Authorization) também são obrigatórias aqui. A forma com /api/v1.0 devolve ids em UUID; a forma /api devolve ids decimais.

POST/api/v1.0/wk_pos_loginAutenticada

Mesmo que pos_login (POST), ids UUID

Igual a POST /api/v1.0/pos_login. Credenciais no corpo JSON ou formulário.

Corpo da requisição

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.
GET/api/v1.0/wk_pos_loginAutenticada

Mesmo que pos_login (GET), ids UUID

Igual a GET /api/v1.0/pos_login. Credenciais na query string; evite em produção, a senha fica na URL.

Parâmetros de consulta

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.
POST/api/wk_pos_loginAutenticada

Mesmo que pos_login (POST), ids decimais

Igual a POST /api/pos_login. Credenciais no corpo JSON ou formulário.

Corpo da requisição

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.
GET/api/wk_pos_loginAutenticada

Mesmo que pos_login (GET), ids decimais

Igual a GET /api/pos_login. Credenciais na query string; evite em produção, a senha fica na URL.

Parâmetros de consulta

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.
POST/api/v1.0/wkposloginAutenticada

Mesmo que pos_login (POST), ids UUID

Igual a POST /api/v1.0/pos_login. Credenciais no corpo JSON ou formulário.

Corpo da requisição

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.
GET/api/v1.0/wkposloginAutenticada

Mesmo que pos_login (GET), ids UUID

Igual a GET /api/v1.0/pos_login. Credenciais na query string; evite em produção, a senha fica na URL.

Parâmetros de consulta

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.
POST/api/wkposloginAutenticada

Mesmo que pos_login (POST), ids decimais

Igual a POST /api/pos_login. Credenciais no corpo JSON ou formulário.

Corpo da requisição

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.
GET/api/wkposloginAutenticada

Mesmo que pos_login (GET), ids decimais

Igual a GET /api/pos_login. Credenciais na query string; evite em produção, a senha fica na URL.

Parâmetros de consulta

user_loginstringobrigatório
E-mail do caixa.
passwordstringobrigatório
Senha do caixa.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1.0/wk_pos_login" \
  -u "$TERMINAL_EMAIL:$TERMINAL_API_KEY" \
  -d "user_login=caixa@minhaloja.com.br" -d "password=senha-do-caixa"

Resposta

200Login aceito (resumo)
json
{
  "status": 200,
  "data": { "success": true, "message": "", "access_token": "eyJhbGciOiJIUzI1NiIs...", "agent_info": { "user_id": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc" } }
}

A resposta completa, com todos os campos, está em Login do caixa.

Erros

Os mesmos de Login do caixa: data.success: false com Required params missing: user_login, password, Incorrect login or password, User not found ou Account is not active (sempre HTTP 200), e 401 quando falta a credencial do terminal.

Os corpos de formulário são o normal nos terminais antigos

O app original enviava user_login e password como formulário, não como JSON. O servidor lê os dois formatos: se o Content-Type não é application/json, o corpo é tratado como formulário.

Veja também

  • Login do caixa
  • Produtos e clientes
Anterior
Fechar a venda
Próxima
Nomes alternativos do catálogo
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também