Esta documentação tem por finalidade auxiliar a integração entre APIs e facilitar a usabilidade da plataforma Narte Agro Automation, que se dispõe a fornecer um meio de integração via REST com outros sistemas de forma fácil e independente de tecnologia.
\nO endpoint da conexão com a API REST JSON possui sempre o mesmo padrão, independente do serviço a ser utilizado:
http[s]://[nome_ou_ip_do_servidor][:8025]/rest/api/recurso
Exemplo:
\n| http://192.168.1.2:8025/rest/api/nome-do-recurso |
|---|
Todos os dados enviados e recebidos pela API estão/deverão ser em formato JSON (application/json).
\nNota importante!
\nComo no exemplo acima, todos os exemplos utilizam uma URL fictícia que deve sempre ser substituída pela URL real, fornecida pela empresa utilizadora das soluções Narte Agro Automation.
A porta usada nos exemplos é a 8025(padrão).
Atualmente existem os seguintes recursos abaixo que você pode manipular através dos métodos GET, POST, PUT e DELETE:
\nPara poder trabalhar com os métodos disponíveis e assim fazer a integração é necessário primeiro realizar a autenticação utilizando um serviço específico, informando usuário, senha (Criptografia MD5) e código da empresa, previamente cadastrados no sistema.
Recomenda-se fortemente criar um usuário específico para cada sistema que venha a utilizar estes serviços, facilitando o controle e auditoria dos dados imputados e lidos por estes.
Qualquer dúvida que surgir durante a implantação, estamos à disposição através do e-mail suporte@narte.com.br ou nosso site www.narte.com.br.
\nSuas sugestões e feedbacks de melhorias também são muito bem vindas!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14906936","collectionId":"f79879bb-7884-4514-a2f6-ebfa72d469b8","publishedId":"UVJWqKvz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-11-21T01:45:44.000Z"},"item":[{"name":"Requisição do Token de Acesso","item":[{"name":"http://localhost:8025/rest/api/bodyauth","id":"a085697a-ad36-4215-ada8-977928eb9eee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"client_user\":\"Admin\",\r\n \"client_password\":\"0FF2548D6A2B622904C3E2DEF70A9D99\",\r\n \"client_company_codigo\":\"1\"}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8025/rest/api/bodyauth","description":"Para se realizar a chamada de um ou mais serviços é necessário primeiro\nrealizar a autenticação utilizando um serviço específico, informando no Body da requisição: o usuário, a senha e o código da empresa, previamente cadastrado no sistema.\nRecomenda-se fortemente criar um usuário específico para cada sistema\nque venha a utilizar estes serviços, facilitando o controle e auditoria dos dados\nimputados e lidos por estes.
\n","urlObject":{"protocol":"http","port":"8025","path":["rest","api","bodyauth"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ef88f588-d127-4e61-a642-db741be33adc","name":"Token de Acesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"client_user\":\"sankhya\",\r\n \"client_password\":\"11A332307CAEF8BB3EC04746FAF3569F\",\r\n \"client_company_codigo\":\"1\"}","options":{"raw":{"language":"json"}}},"url":"https://api.narte.com.br:8025/rest/api/bodyauth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"270"},{"key":"Date","value":"Sun, 21 Nov 2021 22:40:26 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Origin, Accept, Authorization, X-CUSTOM-HEADER"},{"key":"Server","value":"WiRL Server (Indy)"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfY29tcGFueV9pZCI6IjEiLCJjbGllbnRfdXNlciI6ImFkbWluIiwiY2xpZW50X3Bhc3N3b3JkIjoiQzRDQTQyMzhBMEI5MjM4MjBEQ0M1MDlBNkY3NTg0OUIiLCJyb2xlcyI6IkFETUlOIn0.ITvRP0QdPPF2eDpm9XkA70ph5PvNae5k-TNPxvRbs40\"\n}"}],"_postman_id":"a085697a-ad36-4215-ada8-977928eb9eee"},{"name":"http://localhost:8025/rest/api/bodyauth","id":"f08bf539-c37a-4652-8eb5-5639bedababe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"token_request\":\r\n{\"auth_account_user\":\"edgar\",\r\n\"auth_account_password\":\"81DC9BDB52D04DC20036DBD8313ED055\",\r\n\"auth_company_cnpjcpf\":\"\",\r\n\"auth_company_codigo\":\"\",\r\n\"auth_infojson_client\":\"{}\",\r\n\"auth_datetime_token_create\":\"2024-01-19 12:54\",\r\n\"auth_datetime_token_expiration\":\"\"}\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:7700/rest/api/bodyauth","urlObject":{"protocol":"http","port":"7700","path":["rest","api","bodyauth"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"f08bf539-c37a-4652-8eb5-5639bedababe"}],"id":"af221945-2058-4503-a920-d66d98c79eae","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3db19b55-235d-4a27-a3f9-905abb9123ef","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9d48175e-50e4-4caa-8d09-0c7fcd2df7f2","type":"text/javascript","exec":[""]}}],"_postman_id":"af221945-2058-4503-a920-d66d98c79eae","description":""},{"name":"Produto","item":[{"name":"atualizarcusto","id":"78409d51-279e-407b-ad24-3dad49f3b43f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para consultar Pedido de Venda você pode passar o parâmetro opcional {pve_id} na url do endpoint a fim de trazer o resultado de um único pedido. Ao não informar o parâmetro, serão retornados os dados de todos os pedidos, sendo no máximo 100 itens por requisição.
\n| Todos os pedidos: http://localhost:8025/rest/api/pedidovenda |
|---|
| Pedido específico: http://localhost:8025/rest/api/pedidovenda/find/195 |
|---|
Parâmetros de querystring opcionais disponíveis
\n| Parâmetro | Descrição |
|---|---|
| pve_id | Retorna pedido pelo seu ID |
Pode fazer uma consulta no Pedido de Venda através dos Query Params abaixo:
\n","urlObject":{"protocol":"http","port":"8025","path":["rest","api","pedidovenda","filter"],"host":["localhost"],"query":[{"key":"cliente_codigo","value":null},{"key":"status","value":null},{"key":"periodo_inicial","value":null},{"key":"periodo_final","value":null}],"variable":[]}},"response":[],"_postman_id":"1e309fdd-565d-4311-88bc-369d2cf9d81a"},{"name":"Inserir Pedido de Venda","id":"352b4b67-74d8-4e70-8cf0-868980e7847f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para alterar um Pedido de Venda é preciso passar no body do Json o PVE_ID (Número do Pedido de Venda que será alterado). Apenas pedidos com status: AB - Aberto poderão serem excluídos
\n","urlObject":{"protocol":"http","port":"8025","path":["rest","api","pedidovenda"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"add475b4-4e6c-4d10-8318-3b49a1bbf849","name":"Alterar Pedido de Venda","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n\"PVE_ID\": 748, \r\n\"PES_CODIGO_CLIENTE\": 31,\r\n\"PES_CODIGO_VENDEDOR\": 1,\r\n\"NOP_CODIGO\": 1001,\r\n\"RVE_CODIGO\": 40200,\r\n\"PVE_DATAPEDIDO\": \"2022-02-23\",\r\n\"PVE_DATAPREVISAO\": \"2022-02-23\",\r\n\"PVE_MERCADO\": \"I\",\r\n\"PVE_TIPOVENDA\": \"PL\",\r\n\"PVE_STATUS\": \"AB\",\r\n\"PVE_00_01\": \r\n[\r\n{\r\n\"PRO_CODIGO\": 2016,\r\n\"CAE_CODIGO\": 1,\r\n\"MTR_CODIGO\": 1,\r\n\"TBP_CODIGO\": 2,\r\n\"PVE_QTDEMBALAGEMPEDIDO\": 130,\r\n\"PVE_VALORUNITARIO\": 35.6\r\n}\r\n]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8025/rest/api/pedidovenda"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Date","value":"Wed, 23 Feb 2022 03:02:17 GMT"},{"key":"Server","value":"WiRL Server (Indy)"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200\",\n \"statustype\": \"success\",\n \"message\": \"Requisicao Executada com Sucesso!\",\n \"data\": {\n \"params\": [\n {\n \"PVE_ID\": \"748\"\n }\n ]\n }\n}"}],"_postman_id":"ce5a0c03-9624-41c1-915d-d1fd83429ef2"},{"name":"Deletar Pedido de Venda","id":"8868e290-89b6-4fd1-88be-56d6a4fbbbee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8025/rest/api/pedidovenda/232","description":"Para excluir um Pedido de Venda é preciso passar o parâmetro obrigatóriol {pve_id} na url do endpoint a fim de excluir um único pedido. Apenas pedidos com status: AB - Aberto poderão serem excluídos
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para cancelar um Pedido de Venda é preciso passar os Query Params . Apenas pedidos com status: AB - Aberto poderão serem excluídos
\n","urlObject":{"protocol":"http","port":"8025","path":["rest","api","pedidovenda","cancelar"],"host":["localhost"],"query":[{"key":"pve_id","value":"751"},{"key":"mca_codigo","value":"1"},{"key":"pve_observacaocancelamento","value":"Falta de Produto"}],"variable":[]}},"response":[{"id":"f9e12050-7510-4eb0-bd4d-c446f853ccb6","name":"Cancelar Pedido de Venda","originalRequest":{"method":"PUT","header":[],"url":{"raw":"http://localhost:8025/rest/api/pedidovenda/cancelar?pve_id=751&mca_codigo=1&pve_observacaocancelamento=Falta de Produto","protocol":"http","host":["localhost"],"port":"8025","path":["rest","api","pedidovenda","cancelar"],"query":[{"key":"pve_id","value":"751"},{"key":"mca_codigo","value":"1"},{"key":"pve_observacaocancelamento","value":"Falta de Produto"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Date","value":"Wed, 23 Feb 2022 01:50:59 GMT"},{"key":"Server","value":"WiRL Server (Indy)"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200\",\n \"statustype\": \"success\",\n \"message\": \"Requisicao Executada com Sucesso!\",\n \"data\": {\n \"params\": [\n {\n \"PVE_ID\": \"751\"\n }\n ]\n }\n}"}],"_postman_id":"684d9d92-0c48-42bc-b6b7-52ac05fb8dbb"}],"id":"f32445e7-50e0-4371-9de1-036429d7fa93","description":"Com esta API você poderá consultar, criar, alterar e deletar pedidos de venda, na plataforma Narte Agro Automation.
\n","event":[{"listen":"prerequest","script":{"id":"51d3b85e-b2d5-421b-9883-2de3e7eb48f3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b9812ff0-ae0b-404f-a87e-28367a89e777","type":"text/javascript","exec":[""]}}],"_postman_id":"f32445e7-50e0-4371-9de1-036429d7fa93","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Com esta API você poderá consultar ordem de carga na plataforma Narte Agro Automation.
\n","_postman_id":"2f962d80-96d7-4948-b0f0-13acb7a9ce26","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"