Wiki source code of Etiqueta de Rastreio - Enviar
Version 16.1 by WBS Tecnologia on 2021/06/02 16:29
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="jumbotron" %) | ||
2 | ((( | ||
3 | (% class="container" %) | ||
4 | ((( | ||
5 | = Enviar uma Etiqueta de Rastreio na Plataforma = | ||
6 | |||
7 | Neste Método vamos descrever como enviar o PDF de uma etiqueta de rastreio para a Plataforma ERP. | ||
8 | ))) | ||
9 | ))) | ||
10 | |||
11 | (% class="row" %) | ||
12 | ((( | ||
13 | (% class="col-xs-12 col-sm-8" %) | ||
14 | ((( | ||
15 | = Detalhes da Rota = | ||
16 | |||
17 | (% class="box infomessage" %) | ||
18 | ((( | ||
19 | Rota:/BDIApi/RastreioEtiqueta/Salvar/{CODIGO} | ||
20 | ))) | ||
21 | |||
22 | * Parâmetros: | ||
23 | * Requer Autenticação: **Sim ** | ||
24 | * Método: **POST** | ||
25 | * Tipo de Retorno**: OK | Erro** | ||
26 | * Headers: | ||
27 | ** API_TOKEN: Token de Autenticação | ||
28 | * Corpo/Payload | ||
29 | ** Conteudo do PDF da Etiqueta de Rastreio | ||
30 | |||
31 | == Códigos de Status == | ||
32 | |||
33 | * 404 = Sem resultados | ||
34 | * 500 = Erro Interno do Servidor | ||
35 | * 200 = OK | ||
36 | * 403 = Acesso Negado, Token de Autenticação Inválido? | ||
37 | |||
38 | = Detalhes da Ação = | ||
39 | |||
40 | Permite enviar o PDF da Etiqueta de Rastreio para o Sistema ERP da Catavento. | ||
41 | |||
42 | **Esta rota somente suporta o envios de PDFs** | ||
43 | |||
44 | === Query String / Parametros === | ||
45 | |||
46 | |=Header|=Descrição / Validação|=Valor Padrão | ||
47 | |{CODIGO}|Código do Rastreio| | ||
48 | |||
49 | === (% style="font-size:26px" %)Headers(%%) === | ||
50 | |||
51 | Abaixo segue os headers que devem ou podem ser passados para a ação: | ||
52 | |||
53 | |=Header|=Descrição / Validação|=Valor Padrão | ||
54 | |API_TOKEN|[Obrigatório] Token da Autenticação| | ||
55 | |||
56 | == (% style="font-size:29px" %)Corpo(%%) == | ||
57 | |||
58 | O Corpo da Requisição é o Conteudo do PDF em Formato RAW (Bytes), deve ser o um ARQUIVO PDF e não é recomendo que tenha mais de 5MB de Tamanho. | ||
59 | |||
60 | |||
61 | ))) | ||
62 | |||
63 | |||
64 | (% class="col-xs-12 col-sm-4" %) | ||
65 | ((( | ||
66 | {{box title="**Índice**"}} | ||
67 | {{toc/}} | ||
68 | {{/box}} | ||
69 | |||
70 | {{box}} | ||
71 | **Exemplos** | ||
72 | |||
73 | * Exemplo de Payload: BAIXAR | ||
74 | * Exemplo de Resultado: BAIXAR | ||
75 | {{/box}} | ||
76 | ))) | ||
77 | ))) |