API Reference

Estrutura da API

Este tópico fornece uma explicação simples de como funciona os principais conceitos aplicados na Voidr Images API, e os primeiros passos para começar a otimizar suas imagens

A Voidr Images API foi projetada para ser flexível e fácil de usar, com uma estrutura de URL intuitiva que permite otimização e transformação de imagens com pouca configuração.

https://img.voir.co/:nome_do_projeto/:transformações/fetch/:url

URL Base da API

A URL base para todas as requisições referente a otimização e transformação de images:

https://img.voir.co

Cada chamada à API segue o padrão:

/:project/:transformers/fetch/:url

Onde:

  • :project é o identificador único do seu projeto.
  • :transformers é uma cadeia de parâmetros de transformação e otimização aplicados à imagem.
  • :url é o caminho URL original da imagem que você deseja otimizar.

Transformações e Otimizações Disponíveis

As seguintes operações estão disponíveis para uso com a Voidr Images API:

  • Blur: Aplica um efeito de desfoque à imagem para reduzir detalhes e suavizar a textura.
  • Compress: Reduz o tamanho do arquivo da imagem, otimizando para carregamento rápido sem perda perceptível de qualidade.
  • Convert: Muda o formato da imagem, permitindo a conversão entre diferentes formatos de arquivo, como JPEG, PNG, WebP, Tiff e Avif.
  • Crop: Recorta a imagem para um tamanho e proporção específicos, focando em áreas de interesse.
  • Radius: Arredonda os cantos da imagem, podendo criar um efeito de borda circular.
  • Resize: Altera as dimensões da imagem, permitindo escalonamento para cima ou para baixo.
  • Rotate: Rotaciona a imagem em um ângulo específico, oferecendo orientação personalizada.

Exemplo de Uso

Para aplicar múltiplas transformações a uma imagem, concatene-as na URL por exemplo.

  • /resize:650x320/ Para redimensionar uma imagem para 650x320 pixels
  • /compress:90/ Comprimi-la com uma qualidade de 90%
  • /convert:webp/ Convertê-la para o formato WebP:

Utilizando a imagem a partir da url: https://images.unsplash.com/photo-1561336313-0bd5e0b27ec8

https://img.voidr.co/meu_projeto/resize:650x320/compress:90/convert:webp/fetch/https://images.unsplash.com/photo-1561336313-0bd5e0b27ec8

Esse endpoint realizará as operações especificadas e entregará a imagem otimizada em tempo real.

📘

Anexe ?debug=true à sua URL para ativar o modo de depuração

Ative o modo de depuração para melhor experiência durante o desenvolvimento, assim você terá visibilidade sobre possíveis erros durante a integração.

⚠️ Lembre-se de sempre desativar o modo de depuração em produção!