Flowls API 🦉

Bem-vindo(a) à documentação da API Flowls! Neste guia, vamos explicar de forma direta como usar nossa API REST.

O que é REST?

A API Flowls segue o padrão REST (Representational State Transfer). Em termos simples, isso significa que você pode interagir com nossos serviços usando os métodos HTTP padrão, como GET, POST, PUT e DELETE. Esses métodos são a chave para solicitar, criar, atualizar e excluir recursos na nossa plataforma.

JSON

Todas as solicitações e respostas são formatadas em JSON. Certifique-se de definir o header content-Type como application/json ao enviar dados para a API. Da mesma forma, nossas respostas também serão retornadas em JSON.

Autenticação

Para começar a usar a API, você precisará de uma chave de API, que pode ser obtida registrando-se na nossa plataforma. Inclua essa chave no header api-key de suas solicitações para garantir acesso seguro aos recursos.

Escolhendo o idioma

Assim como a plataforma, a nossa API também suporta internacionalização. Você pode escolher o idioma através do header locale, que pode ser definido como pt-BR ou en-US. Por padrão, o idioma en-US será utilizado.

O idioma definido será utilizado para a tradução de algumas strings retornadas pela plataforma, como mensagens de erros e label de campos customizados.

Mão na massa!

Agora que já cobrimos os principais conceitos, vamos fazer o nosso primeiro request! Acesse a página Getting Started ao lado para seguir um exemplo guiado de integração com nosso endpoint para gerenciamento de Produtos.

Fique à vontade para explorar nossa documentação e descobrir todos os endpoints disponíveis, os parâmetros de solicitação necessários e as respostas esperadas. Estamos aqui para ajudar você a integrar o Flowls de maneira eficiente e aproveitar ao máximo nossa plataforma.

Vamos começar a integração e criar experiências incríveis juntos!