Pedidos/Requests:
  • Todos os pedidos à api seguem o seguinte formato:
    http://s.services.clix.pt/[method]/[response_format]?[args]
    • method -> corresponde ao método da api que pretendemos invocar
    • response_format -> corresponde ao formato em que pretendemos receber a resposta, por omissao é JSON
    • args -> argumentos necessarios à invocação do método
  • Caso seja um utilizador 'Clix', pode agregar este serviço à sua conta, aqui, o que lhe irá permitir criar 'shorturls' associados à sua conta.
Respostas/Responses
  • Actualmente apenas JSON é suportado.
  • O campo 'status' pode conter os seguintes valores:
    • OK, pedido executado com sucesso
    • NOK, erro ao executar o pedido
    • NOT_FOUND, quando o valor pelo qual procuramos nao existe
  • Sempre que o 'status' é diferente de 'OK', o campo 'message' encontra-se disponível, a indicar qual o erro.
  • Exemplos
    Exemplo de uma resposta 'OK':
        pedido:
            http://s.services.clix.pt/
    	expand/?shorturl=http://s.clix.pt/f
        
        resposta:
            {"status":"OK",
             "data"  :{"stats":"http://s.clix.pt/f",
                       "originalurl":"http://www.google.com"
                      }
            }
            
    
    Exemplo de uma resposta 'NOT_FOUND':
        pedido:
            http://s.services.clix.pt/
    	expand/?shorturl=http://s.clix.pt/ff
        
        resposta:
            {"status" :"NOT_FOUND",
             "message":"shorturl inválido"
            }
                    
Métodos disponíveis:
  • shortit:
    • url, endereço web para o qual se pretende gerar um shorturl
    • api_key (opcional), utilizador ao qual se pretende associar o shorturl
  • stats:
    • shorturl, para o qual se pretende obter as estatísticas
  • usershorts:
    • api_key, utilizador para o qual se pretende obter os shorturls associados
  • expand
    • shorturl, para o qual se pretende obter a que url está associado