Skip to content

Interface amigável da Link & Track: simplifica rastreamento de encomendas nos Correios através de sua poderosa API.

License

Notifications You must be signed in to change notification settings

Diaszano/linketrackjs

Repository files navigation

logo

linketrackjs

Uma interface amigável para a API de rastreamento de encomendas dos Correios desenvolvida pela Link & Track.

npm npm bundle size npm bundle size NPM GitHub top language

Introdução

O projeto linketrackjs tem como objetivo principal criar uma interface mais amigável e intuitiva para a utilização da API disponibilizada pelo Linketrack, uma plataforma especializada em rastreamento de encomendas.

A API do Linketrack oferece um conjunto de recursos poderosos para rastrear e obter informações sobre pacotes e envios, permitindo que desenvolvedores integrem esses recursos em suas aplicações.

O linketrackjs busca fornecer uma camada intermediária entre a API e os usuários finais. Através dessa camada intermediária, o projeto irá simplificar o processo de integração e fornecer uma experiência mais amigável para os desenvolvedores que desejam incorporar os recursos de rastreamento em suas aplicações.

Instalação

Para instalar a biblioteca, utilize o gerenciador de pacotes npm da seguinte maneira:

npm i linketrackjs

Configuração

Para utilizar a plataforma, é necessário criar uma conta vinculada ao serviço Link & Track. Para proceder com esse registro, é imprescindível enviar um e-mail para [email protected], solicitando a autorização de uso.

Por favor, considere que o envio do e-mail é um requisito obrigatório para acessar as funcionalidades disponíveis. Sua solicitação será processada pela equipe responsável, que fornecerá as informações necessárias para que você possa desfrutar de todas as vantagens oferecidas pelo serviço Link & Track.

Utilização

Para utilizar o cache em sua aplicação, é necessário importar a classe linketrack da biblioteca:

import { LinkAndTrack } from 'linketrackjs';

Em seguida, é possível criar uma instância da classe linkAndTrack e utilizá-la:

const linkAndTrack = new LinkAndTrack('user', 'token');

const track = await linkAndTrack.track('CODIGO');

console.log(track);