Introdução Último update: 15-jan-2024
Bem-vindo e obrigado por escolher nossa API!
Nosso principal objetivo é oferecer uma experiência de integração suave e eficiente, permitindo que você conecte seus sistemas de maneira rápida e descomplicada. Aqui, você encontrará toda a documentação necessária para fazer o melhor uso das nossas APIs. Para facilitar sua navegação, utilize os menus laterais do nosso site e localize rapidamente a API específica que deseja implementar.
Dashboard para execução rápida:
Entendemos a necessidade de flexibilidade e praticidade em operações diárias. Por isso, oferecemos um dashboard intuitivo e de fácil uso. Ideal para quem busca eficiência sem se envolver com aspectos técnicos complexos, nosso dashboard permite que você acesse e execute nossos serviços de maneira ágil. Com uma interface amigável, você pode gerenciar e utilizar nossas funcionalidades de forma eficiente, sem a necessidade de integração de código ou conhecimento técnico avançado. É a solução perfeita para um controle rápido e eficaz dos serviços que oferecemos.
Sistema Pré-Pago:
Nosso sistema pré-pago é projetado pensando na sua segurança e conveniência. Com ele, você tem o controle total dos seus gastos, adicionando créditos à sua conta que podem ser usados conforme sua necessidade. Esta abordagem elimina a dependência de cartões de crédito ou processos de faturamento prolongados, proporcionando uma gestão financeira mais simples e transparente. É um método ideal para manter seus custos alinhados com o seu uso, garantindo uma experiência sem surpresas ou preocupações com gastos excessivos.
Pagamento por Requisição:
Nosso modelo de pagamento por requisição representa uma abordagem justa e orientada para o sucesso do cliente. Você só será cobrado por requisições que são efetivamente processadas e concluídas com sucesso. Isso significa que, em caso de falhas ou erros nas solicitações, você não terá custos adicionais. Este sistema é ideal para garantir que você receba valor real pelo que paga, assegurando uma relação de confiança e transparência entre nós. Com essa estrutura, nosso compromisso com a qualidade e a eficiência dos serviços fica ainda mais evidente.
Características
Facilidade de Integração (Padrão REST):
Nossa API segue o padrão REST, garantindo uma integração fácil e consistente. Isso facilita a compreensão e o uso por parte dos desenvolvedores, pois segue um modelo amplamente adotado e bem documentado na indústria. Nossa API adota o padrão REST (Representational State Transfer), um paradigma amplamente reconhecido e utilizado na criação de serviços web. Este padrão é conhecido por sua simplicidade, escalabilidade e eficiência, tornando-se uma escolha ideal para desenvolvedores que buscam uma integração fácil e robusta.
Principais Características do Padrão REST em Nossa API:
- Arquitetura Baseada em Recursos: Cada recurso da API é identificado por uma URL única, proporcionando um acesso claro e direto. Esta abordagem assegura que cada API tenha seu próprio identificador exclusivo na web, facilitando a localização e a interação com diferentes serviços.
- Comunicação Stateles: Em conformidade com os princípios REST, as requisições são tratadas de forma independente, sem que o servidor necessite manter um estado interno. Isso resulta em uma comunicação mais eficiente, já que cada requisição contém todas as informações necessárias para ser compreendida e processada.
- Uso dos métodos HTTP padrões com Status Codes: A nossa API adota métodos HTTP padrões como GET, POST, PUT e DELETE para realizar uma ampla gama de operações de forma eficaz e padronizada. Estes métodos são fundamentais para a interação com os recursos da API: o método GET é utilizado para recuperar dados, POST para criar novos recursos, PUT para atualizar recursos existentes e DELETE para remover recursos. Além disso, a nossa API aprimora a comunicação fornecendo status codes detalhados em cada resposta. Esses códigos de status facilitam a identificação rápida do resultado de uma operação, permitindo aos desenvolvedores entenderem imediatamente se uma requisição foi bem-sucedida, encontrou um erro, ou necessita de ações adicionais. Essa inclusão de status codes torna o processo de diagnóstico e correção muito mais eficiente, otimizando a experiência de desenvolvimento e garantindo uma maior transparência nas interações com nossa API.
- Formatos de Dados Flexíveis: Nossa API é totalmente compatível com o formato JSON (JavaScript Object Notation), reconhecido por sua eficiência e facilidade de uso. O JSON é amplamente preferido na comunidade de desenvolvimento por sua simplicidade e legibilidade, facilitando tanto o envio quanto o recebimento de dados. Essa escolha garante que os desenvolvedores possam trabalhar com um formato de dados leve, que se integra perfeitamente a diversas linguagens de programação e plataformas. Ao adotar JSON, proporcionamos uma maior flexibilidade para você moldar soluções que atendam precisamente às necessidades e ao contexto específico de sua aplicação, otimizando a troca de informações e a performance geral do sistema.
- Independência de Plataforma e Linguagem: Como o REST usa padrões baseados em HTTP, ele é independente de qualquer plataforma ou linguagem de programação, oferecendo uma grande flexibilidade para integrar sistemas heterogêneos.
Estamos dedicados a oferecer não só uma API poderosa, mas também um suporte ao cliente excepcional. Se tiver dúvidas ou precisar de assistência, nossa equipe está pronta para ajudar.
Softwares Utilizados
Nesta seção, apresentamos uma variedade de softwares que podem ser utilizados para interagir com nossas APIs. É importante destacar que todos os softwares mencionados aqui são de uso individual gratuito. Eles foram cuidadosamente selecionados para garantir que você tenha acesso às melhores ferramentas disponíveis, sem preocupações adicionais de custo. Essas ferramentas vão desde clientes HTTP simples até ambientes de desenvolvimento mais sofisticados, todos projetados para facilitar a sua interação com nossas APIs e otimizar seu fluxo de trabalho. Seja você um desenvolvedor experiente procurando por funcionalidades avançadas, ou alguém iniciando no mundo das APIs, você encontrará o software adequado às suas necessidades nesta seção.
Postman
O Postman é uma ferramenta amplamente utilizada no mundo do desenvolvimento de software para testar APIs, conhecida por sua interface intuitiva e funcionalidades robustas. Ele permite aos desenvolvedores enviar requisições HTTP, como GET, POST, PUT e DELETE, e visualizar as respostas, facilitando a verificação da funcionalidade e confiabilidade de APIs. Além de testar APIs individualmente, o Postman oferece recursos para organizar requisições em coleções, configurar ambientes e variáveis para diferentes cenários de teste, e gerar documentação automatizada, o que é extremamente útil para a colaboração em equipe. Uma característica particularmente notável é a capacidade de realizar testes automatizados, integrando-se assim em pipelines de CI/CD (Continuous Integration/Continuous Deployment). Sua compatibilidade com várias plataformas e a capacidade de extensão para integrar com outros serviços e ferramentas tornam o Postman uma ferramenta essencial e versátil para qualquer desenvolvedor que trabalha com APIs, seja para testes, documentação ou monitoramento.
Últimas Atualizações
Aqui você encontra todas as informações essenciais sobre as mudanças mais recentes em nossas APIs. Esta parte do documento é dedicada a manter você informado sobre qualquer alteração, melhoria ou correção que tenha sido implementada. Entendemos a importância de estar a par das novidades e de como elas podem impactar o uso das APIs, e é por isso que nos comprometemos a atualizar esta seção diligentemente.
Abaixo, você encontrará o change log completo, detalhando cada atualização realizada em nossas APIs. Estas entradas de change log são minuciosas e incluem descrições das alterações, oferecendo clareza e transparência sobre o desenvolvimento e a evolução de nossos serviços. Elas são organizadas cronologicamente, com as mais recentes no topo, para que você tenha fácil acesso às informações mais atuais.
Esta seção é uma ferramenta valiosa para desenvolvedores e usuários das APIs, permitindo-lhes acompanhar mudanças, entender novas funcionalidades e ajustar suas próprias integrações e usos conforme necessário. Seja uma nova funcionalidade, uma melhoria na performance, ou uma correção de bug, tudo é registrado aqui para garantir que você esteja sempre informado e possa tirar o máximo proveito das nossas APIs.
Mantenha-se atualizado com as últimas novidades e assegure que suas aplicações estejam sempre alinhadas com as versões mais recentes e eficientes das nossas APIs, conferindo regularmente esta seção de Últimas Atualizações.
Change Log:
| 14/01/2024 | Para proporcionar uma melhoria significativa na performance, realizamos uma importante atualização em nossa infraestrutura. Os servidores que hospedam nossas APIs foram transferidos para uma nova localização estratégica no leste dos Estados Unidos (us-east). Esta mudança foi cuidadosamente planejada e executada para otimizar a latência, aumentar a confiabilidade e garantir uma melhor distribuição de carga. Esperamos que esta alteração ofereça uma experiência de usuário mais rápida e eficiente, reduzindo os tempos de resposta e aprimorando a estabilidade geral do serviço. Esta atualização é parte do nosso compromisso contínuo em oferecer a melhor performance e confiabilidade possíveis aos nossos usuários. |
|---|
Termos de Uso
Ao acessar e utilizar nossas APIs, você concorda com os seguintes termos e condições, elaborados para garantir uma experiência segura, eficiente e legalmente responsável para todos os usuários. O uso de nossas APIs indica a sua aceitação destes termos, então pedimos que os leia atentamente.
- Uso Responsável: Você deve utilizar nossas APIs de maneira responsável e ética. Qualquer tentativa de explorar bugs ou vulnerabilidades para fins maliciosos ou não autorizados é estritamente proibida. Esperamos que os usuários reportem qualquer falha ou problema de segurança que encontrem, contribuindo para a melhoria contínua do nosso serviço.
- Integração em Sistemas Pagos: Permitimos a integração de nossas APIs em sistemas e aplicativos de terceiros, inclusive aqueles que são pagos. Contudo, é essencial que essa integração respeite os direitos autorais e a propriedade intelectual, tanto da nossa API quanto de terceiros.
- Respeito à Legislação Vigente: O uso de nossas APIs deve estar em conformidade com todas as leis e regulamentos locais, nacionais e internacionais aplicáveis. Isto inclui, mas não está limitado a, leis de proteção de dados e privacidade.
- Limitações de Uso: Reservamo-nos o direito de limitar ou restringir o acesso às nossas APIs, caso identifiquemos usos que violem nossos termos, prejudiquem a performance do sistema ou afetem negativamente outros usuários.
- Mudanças nos Termos de Uso: Os Termos de Uso podem ser atualizados ou modificados periodicamente. É responsabilidade do usuário revisar regularmente estas mudanças. A continuidade do uso de nossas APIs após tais alterações constituirá a aceitação dos novos termos.
- Garantias e Responsabilidades: Enquanto nos esforçamos para garantir a alta disponibilidade e a confiabilidade das nossas APIs, não podemos oferecer garantias absolutas quanto à operacionalidade ininterrupta ou à ausência de erros. Não nos responsabilizamos por quaisquer danos diretos ou indiretos resultantes do uso das nossas APIs.
Ao utilizar nossas APIs, você reconhece que leu, compreendeu e concordou com estes termos. Nosso objetivo é oferecer um serviço de alta qualidade, mantendo um ambiente seguro e respeitável para todos os usuários. Agradecemos sua colaboração e compromisso em aderir a estes termos, assegurando uma experiência positiva e produtiva para todos os envolvidos.
Politica de Segurança & Privacidade
Nossa política de segurança e privacidade está firmemente alinhada com as mais recentes leis gerais de proteção de dados (LGPD), refletindo nosso compromisso com a segurança e a confidencialidade das informações dos nossos usuários. Entendemos a importância da privacidade de dados e tomamos medidas rigorosas para garantir que todas as informações processadas através das nossas APIs sejam tratadas com o máximo cuidado e responsabilidade.
- Uso Responsável dos Dados: Os dados enviados pelos usuários por meio de nossas APIs são utilizados exclusivamente para os fins para os quais foram coletados. Isso inclui o envio de informações necessárias para a prestação do serviço solicitado e a recepção de dados em resposta. Garantimos que essas informações não sejam usadas para outros fins sem o consentimento explícito do usuário.
- Armazenamento de Dados e Logs: Para aprimoramento contínuo dos nossos serviços, armazenamos dados de log que nos ajudam a monitorar e melhorar a performance e a segurança das nossas APIs. Esses logs incluem informações básicas sobre o uso do serviço e são mantidos de acordo com as normas de proteção de dados, garantindo a segurança e a privacidade.
- Retenção de Arquivos Gerados: Os arquivos gerados pelas nossas APIs, como documentos em PDF, XLSX, etc, são retidos em nossos servidores por um período máximo de 15 dias. Após esse prazo, eles são automaticamente excluídos, tornando-se inacessíveis em nosso sistema. Essa medida é uma parte essencial da nossa política de privacidade e segurança, assegurando que os dados pessoais e sensíveis não sejam mantidos por mais tempo do que o estritamente necessário.
- Conformidade com as Leis de Proteção de Dados: Estamos em total conformidade com as leis de proteção de dados vigentes, assegurando que todas as informações sejam tratadas com o mais alto nível de segurança e de acordo com os regulamentos legais.
- Transparência e Confiança: Nos comprometemos a manter uma postura transparente quanto ao uso dos dados, proporcionando aos nossos usuários a confiança de que suas informações estão seguras e sendo utilizadas de forma responsável. Nossa política é continuamente revisada e atualizada para garantir que estejamos sempre alinhados com as melhores práticas e regulamentações mais recentes em proteção de dados.
Reforçamos nosso compromisso com a segurança dos dados e com a privacidade dos nossos usuários. Acreditamos que uma abordagem transparente e responsável em relação à proteção de dados é fundamental para construir e manter a confiança dos nossos clientes, e nos dedicamos a garantir que nossos processos e práticas reflitam esse compromisso.