Descrição da usabilidade das API´s
Funcionalidades
Esclarecer ao usuário das API´s quais são os passos para utilização do painel.
Abrangência
Desenvolvedores e usuários do LInxDms Automotivo API´s.
Aplicação
Informar a rotina de usabilidade de maneira técnica
Modo de utilização
Nosso cardápio está disponibilizado em uma ferramenta completa e de fácil utilização.
Para utilização das API's, é necessário realizar o cadastro de um usuário conforme informado no processo abaixo:
Acesse o sistema Lins DMS Automotivo API aqui:
Na tela inicial, selecione a opção "Cadastrar";
Na tela de cadastro, os campos devem ser preenchidos conforme informado abaixo:
Email: e-mail do responsável (pessoa ou área) que irá utilizar as API's.
Password: Cadastrar uma senha de no mínimo 8 dígitos;
Confirm password: Inserir a mesma senha informada no campo Password;
First Name: Cadastrar o nome da empresa que utilizará o cardápio das API's;
Last Name: Cadastrar o CNPJ da empresa que utilizará o cardápio das API's;
Captcha: Inserir os caracteres (letras e números) que são exibidos na imagem;
Selecionar a opção "Sign up".
Ao final do cadastro, o sistema envia ao cliente no e-mail informado um link para confirmação.
No e-mail recebido pelo cliente, é necessário acessar o link para confirmar a autenticidade do e-mail e ativação do cadastro realizado.
Após a ativação do cadastro, o usuário poderá acessar o sistema de gestão de API's.
Para entrar no sistema o cliente deverá utilizar o Email e Senha cadastrados e selecionar a opção "Sing in" na tela de Login.
Após a autenticação no sistema, o cliente deverá selecionar a opção "Cardápio" ou a opção "Explore APIs" para acessar o cardápio de API's.
Na tela do "Cardápio de API's", o usuário poderá conhecer os conjuntos de API's disponíveis. Para selecionar uma das opções, o cliente deve clicar nos links (destacados em azul) para que possa visualizar as APIs que compõem o item selecionado no cardápio.
Ao selecionar um item do cardápio, será exibida a tela com os agrupamentos das API's disponíveis e a descrição do que cada um destes agrupamentos permite realizar.
É nesta tela que é realizada a solicitação de assinatura para utilização das API's. Para isto o cliente deve inserir no campo "Assinaturas" o "CNPJ – Nome da empresa" e selecionar a opção "Subscribe".
Após o envio da solicitação de assinatura pelo cliente, o sistema gera as chaves primária e secundária e o status da solicitação fica como "Submitted" até que seja avaliada pela equipe da Linx (Comercial e TI) e liberada para utilização.
Na tela de "Assinatura" o cliente também tem a opção de visualizar cada uma das API's selecionando um dos agrupamentos disponíveis.
Na tela que lista os endpoints também são exibidas as informações técnicas para utilização das API's.
Ao selecionar a opção "Try it" são apresentados exemplos de utilização de cada API com as principais linguagens de programação suportadas pela ferramenta.
Acima é exibido um exemplo utilizando JavaScript, mas também poderia ser utilizado HTTP, Curl, C#, Java, PHP, Python, Ruby e Objective C.
