Versões comparadas

Versão antiga 2

changes.mady.by.user Marya Luiza Rocha E Souza

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Marya Luiza Rocha E Souza

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


ProdutoLinx DMS
Menu-
Data

 

Autor

Nelson Scherer Martins

ÁreaLinx DMS



Painel
borderColor#333
titleColor#ffb200
titleBGColor#2C004B
borderStylesolid
titleFinalidade

Este documento tem como finalidade documentar a como realizar a autenticação para utilizar a API com diversas funcionalidades disponibilizadas para parceiros da Linx.


Painel
borderColor#333
titleColor#ffb200
titleBGColor#2C004B
borderStylesolid
titleAbrangência

Esta funcionalidade pode ser utilizada por qualquer parceiro da Linx que possua um acordo para a utilização desta API, juntamente com os clientes.



Painel
borderColor#333
titleColor#ffb200
titleBGColor#2C004B
borderStylesolid
titleAplicação

Existem dois métodos de autenticação para utilizar a API, sendo o determinador a funcionalidade que será utilizada. Para verificar qual o método de autenticação, acesse a documentação da funcionalidade.

Índice

Autenticação V1

Rota/linxdmsds/auth
MétodoGET
DescriçãoGera o token de autenticação que deverá ser utilizado para consumir a API.
Header


AuthorizationBasic CODIGO_AUTENTICACAO
SecretCHAVE_SECRETA_PARCEIRO


Observação

CODIGO_AUTENTICACAO: este código é composto pelo usuário, senha e o CNPJ do cliente que o parceiro estará utilizando a funcionalidade. O código deve ser montado da seguinte maneira: USUARIO:SENHA:CNPJ. Este código deve estar codificado em base 64 para ser enviado.

Exemplo: usuario_api:senha_api:00000111111111

Exemplo codificado em base 64: dXN1YXJpb19hcGk6c2VuaGFfYXBpOjAwMDAwMTExMTExMTEx


CHAVE_SECRETA_PARCEIRO: chave secreta fornecida para o parceiro utilizar a API.


Solicite os dados para realizar a autenticação para o e-mail [email protected].

Response


Bloco de código
themeEclipse
titleStatus 200
collapsetrue
{ "token" : "string" }


ou


{
	"status": "string",
	"mensagens": ["string"],
	"versao": "string"
}



Autenticação V2

Rota/v2/auth
MétodoGET
DescriçãoGera o token de autenticação que deverá ser utilizado para consumir a API.
Header


AuthorizationBasic CODIGO_AUTENTICACAO
SecretCHAVE_SECRETA_PARCEIRO


Observação

CODIGO_AUTENTICACAO: este código é composto pelo usuário, senha e o CNPJ do cliente que o parceiro estará utilizando a funcionalidade. O código deve ser montado da seguinte maneira: USUARIO:SENHA:CNPJ. Este código deve estar codificado em base 64 para ser enviado.

Exemplo: usuario_api:senha_api:00000111111111

Exemplo codificado em base 64: dXN1YXJpb19hcGk6c2VuaGFfYXBpOjAwMDAwMTExMTExMTEx


CHAVE_SECRETA_PARCEIRO: chave secreta fornecida para o parceiro utilizar a API.


Solicite os dados para realizar a autenticação para o e-mail [email protected].

Response


Bloco de código
themeEclipse
titleStatus 200
collapsetrue
{ "token" : "string" }


Bloco de código
themeEclipse
titleStatus 412
collapsetrue
string


Bloco de código
themeEclipse
titleStatus 500
collapsetrue
{
  "erro": {
            "MensagemDeErro": "string",
            "DetalhesDoErro": "string",
            "SqlOrigemErro": "string",
            "ParametrosSql": {},
            "TraceList": "string"
  }
}