FAQ

O que é a API do Simple e para o que ela serve?

A API do Simple é um conjunto de API’s que são necessários para a criação das diversas modalidades de transações existentes na plataforma do simple, constituído por diversos endpoints REST e um endpoint GraphQL.

Qual a diferença da API do Simple para o Simple White Label?

A principal diferença está na personalização das plataformas. Quando falamos da API você poderá conectar em nossos principais serviços e determinar a melhor experiência para seu cliente com sua identidade visual. Quando falamos do Simple White Label é uma ferramenta com uma configuração pré determinada, podendo alterar as cores e logo na plataforma.

Quais rotinas estão disponíveis na API?

Com a API você terá acesso a criação de transações de Remessas para o Exterior nas moedas de: Dólar, Euro, Libra, Dólar Canadense e Dólar Australiano. Bem como acesso a criação de transações de Compra de Papel moeda na praças disponibilizadas pela Frente Corretora.

Quanto tempo demora para realizar a integração com a API do Simple?

Isso irá depender do conhecimento e experiência de sua equipe técnica. Nossa API é fundamentada nas estruturas REST e GraphQL. Dessa forma a estrutura é padronizada, o que facilita a integração.

Onde encontro a documentação da API?

Para ter acesso a API do simple basta clicar no link -> https://docs.commpix.com/simple-api-integration

O que é necessário para receber os acessos de Produção?

Após uma avaliação e aprovação de nossa equipe de QA, forneceremos os acessos de produção em até 1 dia útil.

Qual a diferença entre a Remessa de Disponibilidade e Manutenção?

A Remessa de Disponibilidade é uma remessa para o exterior para uma conta de mesma titularidade. A Remessa de Manutenção de Residentes é para uma conta de pessoa ligada a você como parentes ou pessoas próximas.

Qual o canal para tirar dúvidas sobre a API?

Após a reunião de abertura, passaremos um acesso ao nosso Slack, onde um de nossos POs irá acompanhar e passar todas as instruções para implementação.

Posso realizar a integração apenas com algumas partes da API?

Sim, nossa API é segmentada e você poderá integrar parcialmente com nossa estrutura. Atualmente você poderá integrar individualmente com nosso Cadastro, Remessa de Disponibilidade, Remessa de Manutenção e Papel Moeda. Bem como integrar individualmente com cada moeda no envio de remessas para o exterior.

Como a autenticação é feita?

Existem duas entidades responsáveis por operar a API:

• User Correspondents: usuário de acesso de um correspondente. Esse usuário nada mais é do que as credenciais repassadas ao correspondente no momento em que este tem o acesso do ambiente de demo/produção concedido;

• User Clients: usuário que fornece permissão à um User Correspondent para acessar/operar sobre ele. Esse usuário nada mais é do que o cliente cadastrado pelo próprio User Correspondents na API.

Os endpoints autenticados da API necessitam de autenticação via JWT. O JWT é concebido no momento em que o User Correspondents realiza a sua autenticação, havendo também a possibilidade de validação do JWT pela própria API. Quando os endpoints são ligados a operações de cliente, além do JWT, que identifica o User Correspondents autenticado, é necessário a clientKey, informação que identifica qual é o User Clients que o User Correspondents deseja operar.

Qualquer pessoa pode construir essa integração?

Você precisará de uma equipe técnica com os conhecimentos em programação para realizar a integração.

A API do Simple é segura?

Sim, nossa API segue um padrão de segurança JSON Web Token (JWT) é o Token que acompanha o Bearer. Ele é um padrão aberto, definido pela RFC 7519. Estabelece uma maneira compactada para transmitir um objeto JSON. Além disso, cada cliente possui uma identificação única gerada pela própria API, ao qual denominamos de clientKey, que é utilizada como fator de autenticação nos endpoints que envolvem o cliente.

É possível liquidar a operação na conta da empresa parceira?

Este processo de liquidação que não seja na conta da Frente Corretora deverá ser encaminhado para para seu contato comercial e ele conseguirá prosseguir com sua solicitação junto ao nosso setor de compliance.

É possível plugar apenas algumas cidades do Papel Moeda?

Sim, em sua implementação da API você poderá escolher as cidades que deseja fornecer a venda de Papel Moeda.

Posso aproveitar o cadastro dos clientes que está na minha base de dados?

O processo de aproveitamento do cadastro poderá se dar via chamadas de operações na API. Ao cliente realizar uma operação em nossa plataforma o cadastro do cliente deverá ser enviado para cadastro em nossa base dados.

Posso alterar a faixa do Spread para ter mais atratividade ou aumentar o lucro?

Sim, em nossa painel administrativo iremos realizar a configuração do spread desejado.