Introdução

Como vários outros encurtadores de URLs, temos uma API para encurtar URLs. Mas não fazemos a utilização de nenhum token ou chave de acesso, o que a torna nossa API diferente das outras e mais simples.



encurtar_url

Este método é usado para encurtar uma URL. Ao ser usado, uma id e um link são retornados.

Argumento: url; Requerido: sim

Exemplo:

https://🇧🇷.ml/api/encurtar_url/?url=https://www.google.com

Nota: Caso a URL não especificar um protocolo (http://, https://, etc), será usado o protocolo http:// automaticamente.

Retorno esperado:

{"ok":true,"link":"https://🇧🇷.ml\/xxxxxx","id":"xxxxxx"}

Erros:

{"ok": false, "description": "A URL inserida não pode estar vazia."}

Verifique se você usou o argumento url e se ele não está vazio.

{"ok": false, "description": "A URL não pode ter o domínio de nosso site."}

A URL para ser encurtada não pode ser um de nossos domínios (🇧🇷.ml ou xn--f77h6a.ml). nós bloqueamos estas URLs para evitar redirecionamentos desnecessários. Caso você quiser obter a URL usando um link do nosso site, você pode dar uma olhada no método obter_url

{"ok": false, "description": "Está faltando argumentos. Veja https://🇧🇷.ml/docs#encurtar_url"}

Este erro ocorre quando não é detectado os argumentos necessários na requisição. Verifique se você usou o argumentos necessários e se eles esão escritos corretamente.



obter_url

Este método é usado para obter alguma URL usando a sua ID (gerada no momento em que a URL é encurtada).

Argumento: id; Requerido: sim

Exemplo:

https://🇧🇷.ml/api/obter_url/?id=xxxxxx

Retorno esperado:

{"ok":true,"url":"https://www.google.com"}

Erros:

{"ok": false, "description": "URL não encontrada."}

Como o erro já descreve, não foi encontrado uma URL com a id especificada.

{"ok": false, "description": "Está faltando argumentos. Veja https://🇧🇷.ml/docs#obter_url"}

Este erro ocorre quando não é detectado os argumentos necessários na requisição. Verifique se você usou o argumentos necessários e se eles esão escritos corretamente.