{"info":{"_postman_id":"0caa3cca-24e1-43b5-82eb-f1b2d0af1823","name":"Linx Seta Digital - API","description":"

A API Linx Seta Digital permite que seja feita a integração de plataformas de comércio eletrônico com o ERP Seta. A API permite realizar consultas em pedidos, estoque, notas fiscais, pessoas, produtos, vendas e financeiro, permite também algumas alterações e inclusões na parte de pessoas, vendas e financeiro.

Canais de Comunicação

Caso queira contratar algum dos nossos serviços ou expandir os termos do contrato atual, entre em contato com nosso time comercial através do e-mail: comercial@makertec.com.br.
Caso tenha algum problemas na API ou dúvidas na configuração e utilização, entre em contato com nosso time de suporte pelo e-mail: suporte@makertec.com.br ou pelo telefone (45) 9859 0373.

Autenticação e Segurança

A estratégia de autenticação de requisições HTTP utilizando tokens no header \"x-api-key\" é um método simples e eficaz para proteger uma API Restful. Essa técnica envolve a geração de um token exclusivo para cada cliente que deseja consumir a API, e este token é enviado através do header \"x-api-key\" em todas as requisições realizadas pelo cliente.

O funcionamento conceitual desta estratégia é baseado em um sistema de autorização baseado em chave de acesso (API Key). Cada chave é única e serve como um identificador exclusivo do cliente que está acessando a API. A chave de acesso é gerada pelo provedor da API e é concedida ao cliente após a realização do processo de autenticação.

Quando um cliente deseja consumir a API, ele inclui a chave de acesso no header \"x-api-key\" de todas as suas requisições. Quando uma requisição chega ao servidor da API, ele verifica se a chave de acesso é válida e autoriza ou nega o acesso ao recurso solicitado.

Essa estratégia oferece um alto grau de segurança e é amplamente utilizada em APIs públicas e privadas. No entanto, para garantir a segurança da API, é importante que a chave de acesso seja gerada e armazenada de forma segura, e que o servidor da API valide a chave de acesso em todas as requisições. Além disso, é recomendável que a chave de acesso seja revogada e regenerada periodicamente, para evitar o uso indevido por terceiros não autorizados.

Exemplos de consumo de API utilizando token \"x-api-key\"

Java:

Java

import java.io.BufferedReader;\nimport java.io.IOException;\nimport java.io.InputStreamReader;\nimport java.net.HttpURLConnection;\nimport java.net.URL;\npublic class HttpUrlConnectionExample {\n    public static void main(String[] args) throws IOException {\n        String url = \"https://api.example.com/data\";\n        String apiKey = \"your_api_key_here\";\n        URL obj = new URL(url);\n        HttpURLConnection con = (HttpURLConnection) obj.openConnection();\n        con.setRequestMethod(\"GET\");\n        con.setRequestProperty(\"x-api-key\", apiKey);\n        int responseCode = con.getResponseCode();\n        System.out.println(\"Response code: \" + responseCode);\n        BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));\n        String inputLine;\n        StringBuilder response = new StringBuilder();\n        while ((inputLine = in.readLine()) != null) {\n            response.append(inputLine);\n        }\n        in.close();\n        System.out.println(\"Response body: \" + response.toString());\n    }\n}\n\n

PHP:

PHP

$url = \"https://api.example.com/users\";\n$apiKey = \"my-api-key\";\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array(\n    \"x-api-key: $apiKey\"\n));\n$result = curl_exec($ch);\ncurl_close($ch);\necho $result;\n?>\n\n

C#:

using System;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Threading.Tasks;\nclass Program\n{\n    static async Task Main(string[] args)\n    {\n        var apiKey = \"seu-token-aqui\";\n        var url = \"https://sua-api.com/endpoint\";\n        using (var client = new HttpClient())\n        {\n            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"x-api-key\", apiKey);\n            using (var response = await client.GetAsync(url))\n            {\n                if (response.IsSuccessStatusCode)\n                {\n                    var content = await response.Content.ReadAsStringAsync();\n                    Console.WriteLine(content);\n                }\n                else\n                {\n                    Console.WriteLine($\"Erro ao fazer a requisição: {response.StatusCode}\");\n                }\n            }\n        }\n    }\n}\n\n

URL Encode

Ainda em questão de segurança, as informações são codificadas e decodificadas através de URL Encode, conforme descrita na documentação da URI.

Caso queria conhecer melhor sobre a ferramenta de codificação e decodificação, ou ainda esclarecer suas dúvidas sobre o seu funcionamento, acesse o link.

Construção de Payload, Operador de Filtros e Ordenação de Resultados

Construção de payload

O payload de envio deve ser feito em formato JSON, cada
endpoint tem as informações necessárias, mas todos os endpoints tem um
funcionamento padrão:

no payload de algum endpoint POST, pode ser
informado somente o externalId de algum dado já cadastrado, caso isso
aconteça, será feito o vínculo da informação existente com o que está
sendo cadastrado no POST.
\n
os campos de externalId devem seguir o padrão \"(.*\\D+.*)\", fazendo o uso de expressões regulares, podem receber somente números, números e letras, mas nunca somente letras. Pode ser utilizado esse site para verificar se o externalId está no padrão esperado, selecionando o padrão \"java 8\".
\n

Operador de filtros

Os filtros da API permitem o uso de Operadores,
para um refinamento maior dos resultados, é utilizado o padrão
powershell operators, para incluir o operador no filtro é necessário
inserir a sua sintaxe de utilização, essa sintaxe deve ser informada nos
parâmetros da requisição, no padrão abaixo:
filter[filter_name]=filter_value
filter[filter_name]modifier=operator_option

Onde:
filter: valor fixo, indica que se trata de um filtro de pesquisa.
[filter_name]: nome do atributo que será utilizado como filtro.
filter_value:
valor do atributo que será utilizado como filtro, deve ser informado o
\"%\" antes e depois do valor, e como é utilizado o URL Encode é
necessário verificar a tabela de correlação do que informar no lugar de
\"%\".
modifier: indica que o filtro em questão deve funcionar de uma maneira diferente do padrão, o [filter_name] utilizado no modifier deve ser o mesmo utilizado como atributo de filtro na consulta do endpoint.
operator_option: informar o operador que será utilizado no filtro.