API Lembreto

Documentação

Downloads

Termos & Condições

Como gerar a Assinatura

Criar aplicativo

Essa é a documentação para uso da API Lembreto. Antes de utilizá-la, você precisa ter uma conta, cadastrar seu aplicativo para receber uma chave, ler e aceitar o termo de uso.

Ajuda e observações

Glossário

TOKEN
Código controlador de autenticações que identifica uma autorização realizada pelo usuário da conta, essa autorização pode ser leitura, escrita ou exclusão (read, write ou delete). Exemplo: O token 'xyz' significa que aplicativo 'App do João' tem permissão de 'leitura' sob os dados do 'Manoel'.

MD5
O MD5 (Message-Digest algorithm 5) é um algoritmo de hash de 128 bits unidirecional

FROB
Código controlador de pré-autenticações. Para obter um 'token' você precisa necessáriamente do frob para fazer a troca.

Conceitos de aplicações API Lembreto

Antes de começar a desenvolver com os métodos abaixo e entender o funcionamento de cada um, é de grande importância diferenciar os dois conceitos de aplicativos que a API Lembreto se baseia.

Aplicação hospedada e operada por você:
Se você desenvolveu um aplicativo web que possui funcionalidades de envio de mensagens para o celular dos seus usuários, mas você é quem hospeda e controla a aplicação ou criou um aplicativo desktop fechado, onde só você possui acesso aos fontes, não é necessário implementar o método lembreto.criarAplicativo. Ou seja, seu aplicativo apenas criará canais Lembreto e seus usuários assinarão tais canais.

Exemplo: Aplicativo de alertas SMS que avisa aos usuários interessados em certo item/produto que não havia em estoque, que o mesmo passou a ter.

Aplicação distribuída, instalada e operada por terceiros:
Você pode criar um aplicativo e utilizar sua rede de usuários para distribuí-lo. Cada usuário, instalando seu aplicativo, vai gerar canais e adquirir Assinantes nesses canais. Ou seja, você multiplica suas possibilidades de gerar volume de mensagens. O método lembreto.criarAplicativo surgiu para dividir as responsabilidades do aplicativo para quem o usa, e não especificadamente para o criador. A API Lembreto relacionará sua chave (api_key) como 'PAI', e para todos os que o utilizam, como 'FILHOS'. Dessa forma, a responsabilidade é centrada em quem usa e você ainda permanece com parte do comissionamento de todas as ações feitas pelos seus 'FILHOS'.

Exemplo: Plugin que integra blogs a canais no Lembreto, e ao postarem conteúdo via blog, SMS em tempo real chegaria com o conteúdo para todos os seus assinantes.

Método lembreto.criarAplicativo:
O método é bastante fácil de usar, porém queremos que você entenda bem o seu significado.

Suponha-se que sua chave (api_key) seja: XYZ123.

O seu aplicativo deve ser configurado para que a primeira vez que alguém o instalar e utilizá-lo, seja feita a chamada do método lembreto.criarAplicativo repassando como parâmetro a sua chave XYZ123. A API Lembreto irá interpretar a sua chave como sendo a aplicação 'PAI' e os dois novos valores de retorno do método (apikey e palavrasecreta) que serão respectivos à pessoa que está utilizando-o, como aplicativo 'FILHO'. Ou seja, a cada nova instalação do seu aplicativo, novas chaves e novas palavras secretas serão geradas.

Não deixe a sua palavra secreta à mostra no código do seu aplicativo onde várias pessoas terão acesso ao fonte ou executável. Existem diversos programas para resgatar informações ofuscadas ou criptografadas. Por isso a existência do método citado acima. Ele evita que sua palavra secreta esteja nas mãos de outras pessoas.

Limite de Requisições

As chamadas aos métodos de todos os webservices da API Lembreto serão vistoriadas. Cada tentativa incorreta na utilização do token será contabilizada, alcançando o total de 10 utilizações incorretas o serviço será inabilitado ao solicitante por 24 horas. Além disso, as chamadas aos métodos terão um limite de 20 requisições por hora, exceto para afiliados cadastrados com contrato oficial com o Lembreto.

API - Autenticação