Consulta de crédito

Documentação da API para obter dados sobre os créditos dos usuários de varejo de uma corporação.

Autenticação client credentials

API responsável pela realização da autenticação da aplicação.

Exemplo

curl -X POST \
  http://url_billing/auth/client \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
    "client_id": "minha_app",
    "client_secret": "minha_app_secret",
    "grant_type": "client_credentials",
    "lifetime": 6500,
}'

Resposta

{
    "access_token": "e6f70ef1861a3cavc1585e63afaf07443d905cda",
    "token_type": "bearer",
    "expires_in": 6500
}

API obter usuários varejo da corporação

API responsável por obter a lista de usuários varejo com seus devidos créditos de uma corporação.

  • A autenticação deve ser feita via client credentials. Utilizando o clientid da corporação.

Title

Lista os dados do varejo de usuários da corporação

URL

/user-retail-corporation

Methods

GET

URL Params

page

Number | Opcional (default 1) | Número da paginação.

page_size

Number | Opcional (default 25, máx 500) | Quantidade de itens em cada página.

Success Response

Code: 200 Content: {"total_items":1,"page":"1","page_size":100,"items":[{"id":1,"username":"05964224822","name":"Usuario Teste","serialNumber":"113D","userType":"trial","billingLimits":{"id":1,"limitRules":{"dueDate":{"date":"2024-10-07 23:59:59.000000","timezone_type":3,"timezone":"UTC"},"login":100000000,"signature":2147483647}}}]}

Error Response

Code: 401

Exemplo

curl --location 'http://url_billing/user-retail-corporation?page=1&page_size=100' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer e6f70ef1861a3cavc1585e63afaf07443d905cda' \
--data ''

Last updated