Informações Gerais

Bem-vindo à documentação do ZezoAPI

Essas páginas irão conter a documentação das rotas do ZezoAPI.
Esse ainda é um trabalho em desenvolvimento, portanto algumas rotas podem estar incompletos ou sem documentação por enquanto.

Dúvidas

Se você tiver alguma dúvida ou precisar de ajuda, o ZezoAPI possui um servidor no Discord onde você pode entrar.

Para outras formas de contato, confira a página de contato.

Opções Padrão e Resultados

São opções ou resultados que serão considerados padrão, a não ser que as observações sobre a rota indiquem o contrário.

A URL principal para todas as rotas é https://api.zezofelipe.com.br

As requisições HTTP são suportadas, porém o uso de HTTPS (com TLS 1.2 ou mais recente) é recomendado por segurança.

O método HTTP padrão suportado é o GET.

ZezoAPI detecta o tipo de cliente que está fazendo requisição.

• Se for de um bot, a resposta será enviada como Texto Puro (text/plain).
• Se for de um navegador ou aplicativo, a resposta será enviada como JSON (application/json), que é o formato padrão de dados usado por sistemas.

Tipos de resposta:

Exemplo de Texto Puro:

Estado: Funcionando 

Exemplo de Formato de Dados JSON:

{ "status": "online" } 

Os parâmetros de rota são sempre obrigatórios.

Os parâmetros de consulta nunca serão obrigatórios.

Exemplos de parâmetros de consulta podem ser prefixados por dois pontos (:), por exemplo: :user ou :channel. Esses devem ser omitidos e substituídos pelo valor de entrada das solicitações reais.

Traduções

A ZezoAPI possui suporte básico de localização para alguns endpoints. Atualmente, está disponível principalmente para as rotas da Twitch.

Para usar as opções de localização, utilize o código de idioma de duas letras definido no ISO 639-1:2002 no parâmetro language. O valor padrão é en (inglês) e você pode usar, por exemplo, pt para português ou es para espanhol. O inglês é usado como fallback caso um idioma não seja suportado para determinados tipos de mensagens.

Idiomas Suportados

Você pode verificar a lista mais atualizada de idiomas suportados no código-fonte, mas aqui está uma visão geral rápida:

Exemplos de Uso

Data de criação em português:

Data de criação em espanhol:

Data de criação em francês:

Data de criação em alemão:

Limites de Taxa

De modo geral, as requisições ao ZezoAPI não possuem limites de taxa. No entanto, há algumas exceções para evitar abusos do serviço.

Se sua aplicação precisar de um número maior de requisições do que o especificado, recomendo que utilize diretamente a API do serviço.

Os limites de taxa são aplicados com base no endereço IP de onde a solicitação é feita.

Para Criadores e Moderadores

Alguns de vocês podem estar acessando essa página para utilizá-la com bots (nesse caso, muitas vezes são chamados de customapi). Se for o seu caso, é provável que esteja bastante confuso(a) sobre como utilizá-la, então essa é uma tentativa de explicar algumas coisas.

Se tiver mais alguma dúvida após ler essa mensagem, sinta-se à vontade para acessar nosso servidor no Discord.

Ou, então, entre em contato comigo usando as informações disponíveis na minha página de contato, e farei o possível para responder da melhor forma.

Variáveis de Bot:

A maioria dos bots possuem variáveis especiais que permitem buscar informações de uma fonte externa da internet, geralmente através de uma URL de API.

Os exemplos de rotas para bot na documentação podem incluir variáveis de chat relacionadas às APIs, que serão automaticamente convertidas em nomes de canais, nomes de usuário ou dados relacionados à API.

O Zezo API usa esse recurso das variáveis para oferecer comandos personalizados e dinâmicos no chat.

Esses foram exemplos das plataformas mais populares, se você usa um diferente desses, consulte a documentação do bot que você usa para obter mais detalhes das variáveis suportadas. Fique a vontade para entrar em contato caso precisar de ajuda.

Parâmetros de Rota:

Os parâmetros de rota são valores ordenados.

Isso significa que, na URL, eles devem ser especificados na ordem em que os marcadores de posição os mencionam.
Para os exemplos abaixo, usarei a rota/twitch/followage. Essa rota é exibida como:https://api.zezofelipe.com.br/twitch/followage/:channel/:user
Exemplo 1: https://api.zezofelipe.com.br/twitch/followage/zezofelipe/jinxtally
Exemplo 2: https://api.zezofelipe.com.br/twitch/followage/jinxtally/zezofelipe

Observe como, no primeiro exemplo, "zezofelipe" é o primeiro nome e "jinxtally" é o segundo nome. Isso significa que "zezofelipe" é o canal a ser verificado, e "jinxtally" é a usuária. Quando você troca as posições desses nomes, também muda o que eles representam. No exemplo 2, embora pareça muito semelhante, "jinxtally" é o primeiro parâmetro, ou seja, é tratado como o canal. Já "zezofelipe" é o usuário, o que resulta em um retorno completamente diferente.

Ao contrário dos parâmetros de consulta, eles NÃO são pares chave/valor, são apenas os valores.
Isso significa que :channel por exemplo, deve ser apenas jinxtally.

Parâmetros de Consulta:

Parâmetros de Consulta são pares de chave/valor.
Exemplo: channel=jinxtally

Para definir um parâmetro de consulta, você adiciona um ? após a URL principal e insere sua chave ou valor/chave.
URL de exemplo: https://api.zezofelipe.com.br/twitch/accountage/jinxtally?language=pt

Se quiser especificar mais de um parâmetro de consulta, coloque um & entre cada chave ou par chave/valor.
URL de exemplo: https://api.zezofelipe.com.br/twitch/pastebin/ABCD1234?contains=palavra&comments=true

Pelo fato dos parâmetros de consulta serem pares chave/valor, a ordem deles não importa, o resultado da requisição será o mesmo.

Uso do Bot:

Se você já olhou algumas das rotas da API, pode ter notado que elas mencionam alguns bots e como adicionar a rota específica a esses bots.
Mas cada rota é exibida sem nenhum parâmetro de rota/consulta definido, o que significa que você precisa adicioná-los por conta própria.
Usando as informações que você leu anteriormente sobre esses parâmetros, você só precisa modificar a URL.
Fiz alguns exemplos abaixo, usando a rota/twitch/accountage.

Exemplo do StreamElements: $(customapi.https://api.zezofelipe.com.br/twitch/accountage/jinxtally?language=pt&precision=7)

Exemplo do Nightbot: $(urlfetch https://api.zezofelipe.com.br/twitch/accountage/jinxtally?language=pt&precision=7)

Exemplo do Streamlabs Chatbot: $readapi(https://api.zezofelipe.com.br/twitch/accountage/jinxtally?language=pt&precision=7)

Sumário

O Sumário te leva até as categorias. Para chegar direto na informação de uma rota, é só clicar no nome dela ao acessar a categoria.

Spotify

Steam

Twitch

Variados

YouTube