APIs

Plataforma

Na seção relacionada às APIs do ControlPay, haverá símbolos relacionados às plataformas que recomendamos o uso das mesmas. Caso uma API seja recomendada para uma plataforma, um dos símbolos abaixo estará presente:

= "O uso desta API é recomendado em conjunto com o PayGo Android."

= "O uso desta API é recomendado em conjunto com o PayGo Windows."

= "O uso desta API é recomendado tanto em conjunto com o PayGo Windows quanto com o PayGo Android."

APIs que não tiverem nenhum dos símbolos acima ou não são relacionadas a TEF ou não são recomendadas em conjunto com nenhuma das plataformas acima.

---

Variáveis

Cada API demandará uma ou mais variáveis para a correta utilização. As listamos aqui entre chaves duplas. Ao realizar as chamadas, você deverá trocar os campos com chaves duplas por seus dados e valores desejados.

📘

Exemplo

Url deverá ser substituido por https://sandbox.controlpay.com.br/webapi/

A url dependerá do ambiente no qual as transações estão sendo feitas. No ambiente de produção, a URL é diferente, sendo ela: https://api.controlpay.com.br/ .

🚧

Atenção

Para o envio de uma requisição, o padrão sempre será URL/conjunto de API/Endpoint. Um exemplo disso seria:

• https://sandbox.controlpay.com.br/webapi /Venda/Vender -> URL da API de sandbox / APIs de venda / Endpoint para realizar vendas

É importante ressaltar que a URL da API varia de acordo com o ambiente e que deve-se tomar cuidado com isto. Já que no ambiente de sandbox há o prefixo "/webapi" antes do conjunto da API e no ambiente de produção não.

❗️

Chave de integração

Para o uso das APIs é importante começar pela chave de integração. Os usuários podem obtê-la através da API de Login, contudo recomendamos obter uma chave fixa sem expiração. O procedimento para isto pode ser visualizado em "Chave de integração".

Esta chave será usada na URL das chamadas ao ControlPay, na propriedade "key". Ela sempre será enviada como parâmetro na URL e não no body ou como header.

📘

Observação

É importante lembrar que os valores de propriedades apresentados nos exemplos de chamadas e respostas das APIs não são valores reais e apenas ilustrativos para efeitos dessa documentação.

A seguir estão listadas as API para integração com ControlPay.