Pular para o conteúdo principal

Integrando

Passo 1 - Adquirindo o Token de Acesso​

Usando seu software de testes de endpoint, crie uma requisição com o método POST e adicione a seguinte URL de desenvolvimento na API:

BASE URL
https://auth-hml.carbonext.com.br/auth/realms/co2free/protocol/openid-connect/token

Em Body > x-www-form-urlencoded adicione as chaves e seus valores correspondentes seguindo o exemplo de requisição a seguir:

Exemplo de Requisição​

var axios = require('axios');
var qs = require('qs');
var data = qs.stringify({
        'client_id': '<your_client_id>',
        'client_secret': '<your_client_secret>',
        'grant_type': 'client_credentials' 
});
var config = {
        method: 'post',
        url: 'https://auth-hml.carbonext.com.br/auth/realms/co2free/protocol/openid-connect/token',
        headers: { 
                'Content-Type': 'application/x-www-form-urlencoded'
        },
        data : data
};

axios(config)
        .then(function (response) {
                console.log(JSON.stringify(response.data));
        })
        .catch(function (error) {
                console.log(error);
        });

Ao enviar a requisição, teremos como retorno o access_token que permitirá interagir com nossos endpoints.

Exemplo de Resposta​

{
        "access_token": "kRjvJJpQpwWHoWKi-K_5SO0w0dkAqiO2QudmyoJxlTI",
        "expires_in": 36000,
        "refresh_expires_in": 0,
        "token_type": "Bearer",
        "not-before-policy": 0,
        "scope": "profile email roles"
}

Passo 2 - Consultando o Preço do VCU​

Agora que temos a autorização necessária, vamos consultar o preço da VCU, crie uma requisição com o método GET e adicione a seguinte URL:

BASE URL
https://api-b2b-hml.carbonext.com.br/v1/prices?vcu-amount=1

Note que passamos a quantidade de VCUs (vcu-amount) para a consulta de preço.

Em Authorization, troque o Type para Bearer Token e cole o seu access_token em Value.

Exemplo de Requisição​

var axios = require('axios');

var config = {
        method: 'get',
        url: 'https://api-b2b-hml.carbonext.com.br/v1/prices?vcu-amount=1',
        headers: { 
                'Authorization': 'Bearer <access_token>'
        }
};

axios(config)
        .then(function (response) {
                console.log(JSON.stringify(response.data));
        })
        .catch(function (error) {
                console.log(error);
        });

Exemplo de Resposta​

{
        "vcuPrice": 110.5,
        "currency": "BRL"
}

Passo 3 - Criando um Pedido de VCUs​

Chegou a hora de fazer o primeiro pedido, é agora que será efetivada a quantidade de VCUs necessárias para neutralizar suas emissões no período desejado, crie uma requisição com o método POST e adicione a URL:

BASE URL
https://api-b2b-hml.carbonext.com.br/v1/orders

Em Authorization, troque o Type para Bearer Token e cole o seu access_token em Value e no Body, selecione o tipo JSON com os seguintes dados:

{
        "vcuAmount":3,
        "targetCurrency":"BRL"
}

Exemplo de Requisição​

var axios = require('axios');
var data = JSON.stringify({
        "vcuAmount": 3,
        "targetCurrency": "BRL"
});

var config = {
        method: 'post',
        url: 'https://api-b2b-hml.carbonext.com.br/v1/orders',
        headers: { 
                'Authorization': 'Bearer <access_token>', 
                'Content-Type': 'application/json'
        },
        data: data
};

axios(config)
        .then(function (response) {
                console.log(JSON.stringify(response.data));
        })
        .catch(function (error) {
                console.log(error);
        });

Exemplo de Resposta​

{
        "id": "c74de45c-7c6e-4f64-8a1f-271536445abc",
        "vcuAmount": 3,
        "vcuUnitPrice": 110.00,
        "totalPrice": 330,
        "targetCurrency": "BRL",
        "status": "Paid",
        "createdAt": "2022-07-12T14:34:17.075459",
        "notifyCertificateTo": null,
        "type": "Subscription",
        "paymentDate": null,
        "metaData": null,
        "retireForRecipient": false,
        "certificateRecipientInfo": {
                "name": "Empresa First",
                "email": "example@email.com",
                "taxId": "62.650.503/7304-86",
                "fileUploadKey": null,
                "origin": 7,
                "emailTemplateKey": null,
                "notificationEmailVariables": null,
                "fileTemplateKey": null,
                "certificateFileVariables": null
        }
}

Passo 4 - Consultando seu Saldo Atual​

Agora, você pode consultar o seu saldo atualizado, para isso crie uma requisição com o método GET e adicione a seguinte URL.

BASE URL
https://api-b2b-hml.carbonext.com.br/v1/customers/balance

Em Authorization, troque o valor do Type para Bearer Token e cole o seu access_token em Value.

Exemplo de Requisição​

var axios = require('axios');

var config = {
        method: 'get',
        url: 'https://api-b2b-hml.carbonext.com.br/v1/customers/balance',
        headers: { 
                'Authorization': 'Bearer <access_token>'
        }
};

axios(config)
        .then(function (response) {
                console.log(JSON.stringify(response.data));
        })
        .catch(function (error) {
                console.log(error);
        });

Exemplo de Resposta​

{
        "startDate": "2022-07-12T14:12:13.714817",
        "endDate": "2022-07-21T17:00:25.0851306Z",
        "balancesByCurrency": [
                {
                        "currency": "BRL",
                        "vcuBalance": {
                                "type": "VCU",
                                "balance": 15.997878,
                                "credit": 16.0,
                                "debt": 37.53443683424,
                                "futureDebt": 9.0
                  }
                }
        ]
}
info

Veremos mais sobre as requisições de autorização e outros conceitos na próxima página.