Skip to main content

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!