api-doc.hubnai.com Open in urlscan Pro
54.205.239.47  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (1)




Public


Documentation Settings

ENVIRONMENT
Hubnai Sandbox

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Hubnai API Documentation
Introduction
Introdução
Autenticação
Pagamentos
PIX
Link de Pagamento
Recorrência
Estabelecimentos
Liquidações
Antecipações
Webhook's
Status
Outros


HUBNAI API DOCUMENTATION

Essa coleção documenta a API de Antecipação da plataforma, incluindo informações
sobre modelos de antecipação manual e automática.


INTRODUÇÃO

O objetivo desta documentação é orientar o desenvolvedor sobre as integrações de
API's, descrevendo as funcionalidades e métodos a serem utilizados, listando
informações a serem enviadas e recebidas e provendo exemplos.

Nesse manual você encontrará a referência sobre todas as operações disponíveis
na API REST. As operações podem ser utilizadas por meio da chave específica de
integração de sua loja ou através da chave de sessão gerada pela autenticação de
seu estabelecimento. Para saber mais informações a respeito da autenticação,
Introdução a autenticação

Além disso, é necessário que o desenvolvedor esteja atento com o ambiente a ser
utilizado, já que cada um exige procedimentos de autorização e autenticação
diferentes. A seguir informações de domínio do ambiente para cada ambiente:

Base URL Ambiente https://api-sandbox.hubnai.com Homologação
https://api.hubnai.com Produção


AUTENTICAÇÃO


INTRODUÇÃO A AUTENTICAÇÃO

Essa é a sessão da documentação destinada ao esclarecimento dos modelos de
autenticação presente em nossas API's. A primeiro momento, vale-se dizer que a
depender do endpoint a ser utilizado pelo seu estabelecimento é necessário
utilizar um modelo de autenticação adequado ao método a ser utilizado.

Por exemplo, ao utilizar recursos como "Estabelecimentos", "Antecipações",
"Pagamentos", "Link's de Pagamento", "Recorrência", "Liquidações" e "Pix" é
necessário a utilização da autenticação de pagamento.


AUTENTICACAO


AUTENTICAÇÃO DE PAGAMENTO

A Autenticação de Pagamento é um modelo de autorização e autenticação de chave
única na qual é responsável por identificar o cliente e validar seu acesso ao
endpoint. Nesse estilo de autenticação, não há a necessidade de geração de um
token temporário de sessão, visto que é baseado no padrão Bearer Authentication.

Recursos Estabelecimentos Antecipações Pagamentos Link de Pagamentos Recorrência
Liquidações Pix Webhook's


COMO OBTER A CHAVE ÚNICA DA AUTENTICAÇÃO DE PAGAMENTO?

Para obter a chave única de autenticação de pagamento, chamada de access token,
é necessário que um operador com a permissão de visualização da chave de
integração acesse a plataforma através do link <https: api.rakim.com.br=""
login="">e entre na sessão "Minha Conta", conforme imagem a seguir:

Imagem de demonstração de como você pode encontrar sua chave de integração na
plataforma.

> 🚧 Não consegui encontrar minha chave





GETAUTENTICAÇÃO DE APLICATIVO

https://api-sandbox.hubnai.com/app/app/api/login

Esse é o endpoint destinado a Autenticação de Aplicativo (AppAuth) na qual
contempla os recursos de Estabelecimento e Antecipação. Para mais informações a
respeito da autenticação clique aqui.

Example Request
Autenticação de Aplicativo

curl


curl --location 'https://api-sandbox.hubnai.com/app/api/login'

Example Response
 * Body
 * Headers (1)

json


{}

Content-Type

application/json