e
| View file | ||
|---|---|---|
|
...
| Bloco de código |
|---|
{"CodEnt":1,"CNPJ":01.000.000/0001-99,"RzSocial":FULANO DE TAL,... |
Retorno Sem Sucesso
Será retornado um objeto JSON com o motivo da não inclusão (poderá ser um erro de autenticação caso o token tenha expirado ou seja inválido ou alguma regra de negócio não atendida. O status da resposta sempre será diferente de 200.
| Bloco de código |
|---|
{"error":"Cliente... e valido","status":422} |
...
Introdução
Este webservice tem por finalidade retornar dados de UM cliente. Não é necessário informar a empresa ao obter o token.
| Nota |
|---|
Para acessar este método, o usuário deverá ter a permissão de usuário conforme perfil |
Endereço
<endereço do SispetroWeb>/entidade/get_entidade_api?id=<id da entidade>
Parâmetros
Será necessário enviar um header com o token. Como parâmetro enviar:
Nome | Descritivo | Exemplo | Observações |
|---|---|---|---|
id | Código do Cliente que se deseja os dados. | 2550 | Obrigatório |
Headers
...
Nome
...
Descritivo
...
Exemplo
...
Observações
...
Authorization
...
Conteúdo do token obtido no passo de autenticação do usuário
...
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAxLjgwNC4zNDUvMDAwMS02MCIsImV4cCI6MTUwMDA1MzYxN30.-ZvhWFYI8fyx66b3kZY1UVUrfaWUTioV3_M6K2wiPGM
...
Content-Type
...
tipo do formato de envio
...
application/json
...
Accept
...
tipo do formato de envio
...
application/json
Método
GET
Exemplo de chamada de WebService
| Bloco de código |
|---|
curl -H "Content-Type: application/json" -H "Accept: application/json"
-H "Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAzLjk4MC43NTQvMDAwMy0wNSIsImRlcG9zaXRvX3BhZHJhbyI6IjEiLCJleHAiOjE3MjM1NTAwMTN9.IeVJImGIv4_Ko__pYQMQgmC0ehTcyNnGlCUMZoR75M8"
-X GET http://localhost/entidade/get_entidade_api\?id\=6426 |
Retorno Bem Sucedido
Serão retornados todos os dados relativos ao cliente consultado se encontrado. O status da resposta sempre será 200.
Layout conforme retorno de https://futura.atlassian.net/wiki/spaces/ESP/pages/4691329025/API+para+Vendas#1.-Inclus%C3%A3o-Cliente
Retorno Sem Sucesso
Será retornado um objeto JSON com o motivo da não inclusão (poderá ser um erro de autenticação caso o token tenha expirado ou seja inválido ou alguma regra de negócio não atendida. O status da resposta sempre será diferente de 200.
| Bloco de código |
|---|
{"error":"Cliente... nao e valido","status":422} |
3. Clientes alterados
Introdução
Este webservice tem por finalidade retornar dados de clientes que sofreram alguma alteração a partir da data/hora informada.
| Nota |
|---|
Para acessar este método, o usuário deverá ter a permissão de usuário conforme perfil |
Endereço
<endereço do SispetroWeb>/entidade/clientes_alterados?data_hora_inicial=<data hora inicio alteracao>
Parâmetros
Será necessário enviar um header com o token. Como parâmetro enviar:
...
Nome
...
Descritivo
...
Exemplo
...
Observações
...
data_hora_inicial
...
Data e hora inicial (Formato: yyyy-mm-dd hh:mm)
...
“2023-10-23 13:37”
...
Obrigatório
Headers
...
Nome
...
Descritivo
...
Exemplo
...
Observações
...
Authorization
...
Conteúdo do token obtido no passo de autenticação do usuário
...
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAxLjgwNC4zNDUvMDAwMS02MCIsImV4cCI6MTUwMDA1MzYxN30.-ZvhWFYI8fyx66b3kZY1UVUrfaWUTioV3_M6K2wiPGM
...
Content-Type
...
tipo do formato de envio
...
application/json
...
Accept
...
tipo do formato de envio
...
application/json
Método
GET
Exemplo de chamada de WebService
| Bloco de código |
|---|
curl -H "Content-Type: application/json" -H "Accept: application/json" -X GET -H
"Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAzLjk4MC43NTQvMDAwMy0wNSIsImRlcG9zaXRvX3BhZHJhbyI6IjEiLCJleHAiOjE3MjM2NjA2Mjl9.Jrx6JRm4i6C18MillNsbnSEnx47i4ae7rnF_vKmn86o"
http://localhost/entidade/clientes_alterados\?data_hora_inicial=2024-08-10%2012:00 |
Retorno Bem Sucedido
Serão retornados todos os dados relativos aos clientes alterados a partir da data/hora informada. O status da resposta sempre será 200.
Layout de matriz (um para cada cliente modificado) em formato JSON.
...
Item
...
Chave
...
Conteudo
...
1
...
CodEnt
...
Código da entidade alterada ou excluída
...
2
...
FlagOperacao
...
I = inclusão, U = alteração ou E = exclusão
...
3
...
entidade
...
mesmo layout de retorno de um cliente https://futura.atlassian.net/wiki/spaces/ESP/pages/4691329025/API+para+Vendas#1.-Inclus%C3%A3o-Cliente
| Nota |
|---|
Se o flagOperação for igual a 'E' (exclusão), não retorna a estrutura entidade. |
Retorno Sem Sucesso
Será retornado um objeto JSON com o motivo da não aceitação (poderá ser um erro de autenticação caso o token tenha expirado ou seja inválido ou alguma regra de negócio não atendida. O status da resposta sempre será diferente de 200.
| Bloco de código |
|---|
{"error":"Cliente... e invalido","status":422} |