Carregando documentação
Aguarde enquanto a base SQLite é validada.
Aguarde enquanto a base SQLite é validada.
API de integração no modelo padrão Mastersales/TOTVS CRM SFA, com autenticação por usuário e senha.
Autenticação: Basic Auth
GET - Filtra os dados pelos parâmetros disponíveis em cada entidade. Quando nenhum parâmetro é enviado, retorna a consulta completa.
Exemplo com parâmetro: /wspr/cliente?idnativo=1&sgltipopessoa=PJ
Exemplo sem parâmetro: /wspr/cliente
POST - Insere registros. Em todas as entidades, o campo externalid é obrigatório por representar o código de cadastro vindo do ERP.
PUT - Atualiza registros. Informe externalid ou internalid nos parâmetros da URL. Quando ambos forem enviados, o internalid tem prioridade.
DELETE - Remove apenas um registro por chamada. Exclusão em massa não é permitida. A exclusão pode ser feita por externalid ou internalid.
Exemplos:
/wspr/localtabelapreco?externalid=XXXXX /wspr/localtabelapreco?internalid=XXXXX
Para enviar dados com caracteres especiais na URL da requisição, utilize a tabela de referência de caracteres de escape.
https://www.december.com/html/spec/esccodes.html
Data: utilize o formato yyyy-MM-dd.
Números decimais: utilize o formato NUMERIC(18,6), com até 12 casas antes da vírgula e 6 casas decimais.
Exemplo: 123456789123.000000
Em todas as APIs com corpo de requisição, o payload deve possuir obrigatoriamente a tag dados como array, mesmo quando for enviado apenas um registro.
Para rotas compostas documentadas com dados[].json, envie os campos da entidade dentro de json. Para as demais rotas, envie os campos diretamente dentro de cada item de dados.
Exemplo:
{
"dados": [
{
"descricao": "A",
"idnativo": 1,
"externalid": "1"
},
{
"descricao": "B",
"idnativo": 1,
"externalid": "2"
}
]
}
Observação: siga sempre o formato específico de cada entidade.
A ordem agrupa as entidades conforme os cadastros que precisam existir previamente.
As dependências exibidas são a lista consolidada da auditoria das functions PostgreSQL de POST e PUT, persistida uma única vez no SQLite.