Skip to main content

Primeiros Passos

Esta página mostra como dar os primeiros testes na API da Flowls, garantindo que seu ambiente e credenciais estão corretos antes de avançar para exemplos de CRUD.

Ambientes disponíveis​

A API da Flowls possui dois ambientes segregados: Homologação (HML) e Produção (PROD). Ambos utilizam o mesmo domínio:

https://api.flowls.app/api

A diferenciação entre os ambientes é feita pela chave da API (api-key) e pelo operation_id utilizado nas requisições. O operation_id pode ser encontrado fazendo a chamada de listagem de operações (veja abaixo).

Autenticação​

Todas as requisições devem conter os seguintes headers:

  • Content-Type: application/json
  • api-key: sua chave de acesso à API Flowls (fornecida pela equipe)
  • locale: idioma das mensagens (pt-BR ou en-US, padrão: en-US)

Teste de conexão: listando operações​

Para validar sua integração e obter o operation_id, faça uma requisição simples de listagem de operações:

curl -X GET \  
  -H "Content-Type: application/json" \  
  -H "api-key: SUA_API_KEY" \  
  -H "locale: pt-BR" \  
  https://api.flowls.app/api/operations

Exemplo de resposta de sucesso​

  • HTTP 200 OK
  • Corpo com JSON:
{
  "data": [
    {
      "id": 54,
      "type": "FOREIGN_TRADE",
      "title": "IMPO Operation",
      "actor": {
        "id": 6599,
        "nickname": "OPERATION_OWNER",
        "official_name": "OPERATION_OWNER"
      },
      "subtitle": "",
      "sub_type": "IMPORT"
    }
  ]
}

Se retornar data: [], a chamada funcionou corretamente, mas não há operações configuradas ainda. Anote o campo id de cada operação para usar como operation_id nos próximos endpoints.

Próximos passos​

Agora que a conexão está validada, siga para a seção CRUD de Produtos, onde ensinamos como criar, atualizar e remover produtos via API.

Você pode utilizar nossas collections de exemplo para testar os endpoints no Postman:

Importação​

📥 Download da Collection Flowls (.zip)

Exportação​

📥 Download da Collection Flowls (.zip)

O que vem a seguir?​

Agora que você já conseguiu testar sua conexão, siga para a próxima seção onde você verá exemplos práticos de como realizar o CRUD de Produtos.