Bitw.in API
O Bitw.in disponibiliza uma poderosa API para uso por aplicativos e usuários com desejo de integração à páginas web. Abaixo, segue a Documentação desta API, que será documentada aos poucos e têm como objetivo oferecer o máximo de recursos com o máximo de simplificdade.
Seções
Conhecendo a API
A API do Bitw.in é baseada em requisições em REST(em breve, também será suportado o protocolo OAuth) e tem sempre como base a URL http://bitw.in/api , sendo que, em alguns poucos casos, pode ser explicitamente necessário a realização de uma autenticação, como vista na próxima seção.
Autenticação
A Autenticação de um aplicativo para uso da API não é explicitamente necessária em muitos dos casos, todavia, através dela é possível permitir a organização dos Links pelo usuário, que pode, opcionalmente, Criar uma conta gratuita no Bitw.in.
Para realizar autenticação pela API do Bitw.in, basta enviar um parâmetro 'apikey' junto à URL desejada, contendo, este, a API Key do Usuário em questão, que pode ser obtida na página de edição do Perfil. Assim como apresentado abaixo:
apikey=SUA_API_KEY
Nota: A 'SUA_API_KEY' apresentada acima serve somente para fins didáticos, não sendo válida em nenhuma situação.
/api/link/create
Permite encurtar uma determinada URL longa, retornando uma URL curta correspondente à ela.
Parametros
- url - A URL Longa à ser encurtada, precisa ser necessariamente codificada, de acordo com os padrões de Codificação de URLs.
- keyword - Serve para disponibilizar a URL longa em questão em um formato personalizado, ou seja, com o final da URL curta em questão personalizado com o valor passado aqui. NOTA: Caso tal valor já esteja sendo usado, o sistema retornará um Erro e negará a criação da URL, sendo tal opção completamente Case Sensitive.
- publicstats - Permite definir se a URL em questão terá suas estatísticas apresentadas publicamente ou não, aceita como valores: '1' para sim ou '0' para não.
- domain - Define sob qual Domínio a URL em questão será encurtada, sendo o padrão 'bitw.in'. Será válido em breve para outros domínios.
Formatos aceitos
Este Método suporta atualmente os formatos XML, json, txt e html, sendo este anexado como extensão de um arquivo no final do método, antes da Query-String(ex.: http://bitw.in/api/link/create.json?url=http://www.google.com - Sendo que a resposta será retornada, no exemplo, em json).
Métodos de Requisição
Este Método suporta atualmente tanto o Método GET quanto o POST, sendo POST recomendado para URLs excessivamente longas e ainda para compatibilidade com determinados navegadores.
/api/text/create
Permite a Publicação de Textos Longos através de aplicativos. Retornando como resposta os dados da URL Curta gerada junto ao texto.
Parametros
- text - Contém o Texto à ser efetivamente publicado.
- title - Contém o Titulo do Texto à ser Publicado, é explicitamente opcional.
- keyword - Serve para disponibilizar o Texto em questão em um formato personalizado, ou seja, com o final da URL curta em questão personalizado com o valor passado aqui. NOTA: Caso tal valor já esteja sendo usado, o sistema retornará um Erro e negará a publicação do texto, sendo tal opção completamente Case Sensitive.
- publicstats - Permite definir se a URL em questão terá suas estatísticas apresentadas publicamente ou não, aceita como valores: '1' para sim ou '0' para não.
Formatos aceitos
Este Método suporta atualmente os formatos XML, json, txt e html, sendo este anexado como extensão de um arquivo no final do método, antes da Query-String(ex.: http://bitw.in/api/text/create.json?text=EXEMPLO - Sendo que a resposta será retornada, no exemplo, em json).
Métodos de Requisição
Este Método suporta atualmente tanto o Método GET quanto o POST, sendo POST recomendado para Textos excessivamente longas e ainda para compatibilidade com determinados navegadores.
/api/image/upload
Permite o Upload de Imagens ao servidor do Bitw.in e retorna como resposta os dados da URL Curta gerada.
Parametros
- image - Contém a Imagem que será enviada ao servidor, correspondentemente codificada para corresponder à um Upload. Deve ter no máximo 5 MB caso não esteja-se utilizando a autenticação da API, ou no máximo 10 MB caso a API esteja sendo autenticada com sucesso. Deve também estar nos formatos JPG, GIF, PNG ou BMP, tendo ainda seu conteúdo explicitamente verificado para evitar imagens corrompidas.
- title - Contém o Titulo da Imagem à ser Publicada, é explicitamente opcional.
- keyword - Serve para disponibilizar a Imagem em questão em um formato personalizado, ou seja, com o final da URL curta em questão personalizado com o valor passado aqui. NOTA: Caso tal valor já esteja sendo usado, o sistema retornará um Erro e negará a publicação do texto, sendo tal opção completamente Case Sensitive.
- publicstats - Permite definir se a URL em questão terá suas estatísticas apresentadas publicamente ou não, aceita como valores: '1' para sim ou '0' para não.
Formatos aceitos
Este Método suporta atualmente os formatos XML, json, txt e html, sendo este anexado como extensão de um arquivo no final do método, antes da Query-String(ex.: http://bitw.in/api/image/upload.json?text=EXEMPLO - Sendo que a resposta será retornada, no exemplo, em json).
Métodos de Requisição
Para o Uso deste Método, recomendamos explicitamente que se use POST, uma vez que trata-se de um Upload de uma imagem, da qual o método GET simplesmente não pode tratar de maneira eficiente.