Documentação da API v1

Bem-vindo à documentação da API Fluir. Esta API permite que desenvolvedores integrem suas aplicações ao nosso sistema e realizem operações diversas.

Para usar nossa API, é necessário incluir sua chave de API no cabeçalho de cada solicitação. A chave é fornecida quando você se registra para acesso à API.

Clientes

Endpoint para Consulta:

Onde VALOR_DO_DOC deve ser substituído pelo CNPJ que você deseja consultar. Obrigatório.

---

Endpoint para Adicionar:

Campos

---

Endpoint para Atualizar:

Campos

PHP

                            $apiUrl = 'https://api.praxisgestao.com.br/api/fluirme/v1/customer/con/';
                            $authToken = 'SUA_CHAVE_API';
                            $docToQuery = 'VALOR_DO_DOC';
                        
                            $ch = curl_init("$apiUrl?doc=$docToQuery");
                            curl_setopt($ch, CURLOPT_HTTPHEADER, ["Auth-Token: $authToken"]);
                            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                            
                            $response = curl_exec($ch);
                            curl_close($ch);
                            echo $response;
                        

JavaScript

                            const apiUrl = 'https://api.praxisgestao.com.br/api/fluirme/v1/customer/con/';
                            const authToken = 'SUA_CHAVE_API';
                            const docToQuery = 'VALOR_DO_DOC';
                            
                            fetch(`${apiUrl}?doc=${docToQuery}`, {
                                headers: {
                                    'Auth-Token': authToken
                                }
                            })
                            .then(response => response.json())
                            .then(data => console.log(data));
                        

Ruby (usando 'net/http')

                            require 'net/http'
                            require 'uri'
                            
                            api_url = 'https://api.praxisgestao.com.br/api/fluirme/v1/customer/con/'
                            auth_token = 'SUA_CHAVE_API'
                            doc_to_query = 'VALOR_DO_DOC'
                            
                            uri = URI.parse("#{api_url}?doc=#{doc_to_query}")
                            http = Net::HTTP.new(uri.host, uri.port)
                            request = Net::HTTP::Get.new(uri.request_uri)
                            request["Auth-Token"] = auth_token
                            
                            response = http.request(request)
                            puts response.body
                        

C#

                            using System.Net;
                            
                            string apiUrl = "https://api.praxisgestao.com.br/api/fluirme/v1/customer/con/";
                            string authToken = "SUA_CHAVE_API";
                            string docToQuery = "VALOR_DO_DOC";
                            
                            WebClient client = new WebClient();
                            client.Headers.Add("Auth-Token", authToken);
                            string response = client.DownloadString($"{apiUrl}?doc={docToQuery}");
                            Console.WriteLine(response);
                        

Node.js

                            const axios = require('axios');

                            const apiUrl = 'https://api.praxisgestao.com.br/api/fluirme/v1/customer/con/';
                            const authToken = 'SUA_CHAVE_API';
                            const docToQuery = 'VALOR_DO_DOC';

                            axios.get(`${apiUrl}?doc=${docToQuery}`, {
                                headers: {
                                    'Auth-Token': authToken
                                }
                            })
                            .then(response => {
                                console.log(response.data);
                            });
                        

React

                            import React, { useState, useEffect } from 'react';

                            function App() {
                                const [data, setData] = useState(null);
                                const apiUrl = 'https://api.praxisgestao.com.br/api/fluirme/v1/customer/con/';
                                const authToken = 'SUA_CHAVE_API';
                                const docToQuery = 'VALOR_DO_DOC';

                                useEffect(() => {
                                    fetch(`${apiUrl}?doc=${docToQuery}`, {
                                        headers: {
                                            'Auth-Token': authToken
                                        }
                                    })
                                    .then(response => response.json())
                                    .then(data => setData(data));
                                }, []);

                                return (
                                    {JSON.stringify(data, null, 2)}
                                );
                            }

                            export default App;
                        

Respostas bem-sucedidas

Uma resposta bem-sucedida da API retornará um código de status HTTP 200 e o corpo da resposta conterá os dados solicitados em formato JSON.

---

Erros Comuns

Aqui estão alguns dos erros mais comuns que você pode encontrar ao usar a API:

• 400 Bad Request: Sua solicitação está malformada ou faltando parâmetros.
• 401 Unauthorized: Sua chave da API é inválida ou expirou.
• 404 Not Found: O recurso solicitado não foi encontrado.
• 500 Internal Server Error: Algo deu errado no nosso lado. Entre em contato conosco se isso continuar acontecendo.

---

Tratando erros em sua aplicação

É essencial que sua aplicação esteja preparada para lidar com possíveis erros ao fazer requisições à API. Sempre verifique o código de status da resposta e tome as ações adequadas com base nele. Por exemplo, se você receber um código 401, pode ser necessário que o usuário gere uma nova chave da API.

Como obtenho uma chave de API?

Para obter uma chave de API, você precisa ter um usuário com perfil de administrador, acesse a sessão Adminitração > Integrações.

---

Quais são os limites de solicitação para a API?

Usuários gratuitos têm um limite de 10 solicitações por dia. Para limites mais altos, considere atualizar para um de nossos planos pagos.

---

Os dados retornados pela API estão sempre atualizados?

Sim, os dados estão sempre atualizados.