Skip to main content

Como acessar a API com uma empresa afiliada?

Criando o acesso via API​

Nós disponibilizamos o endpoint /api/openpix/v1/partner/application para que você possa criar uma nova application para a respectiva empresa afiliada.

Você pode acessar aqui a documentação referente a esse endpoint.

Como parte do body da requisição, esperamos o envio dos seguintes itens: application e taxID, respectivamente, eles consistem no seguinte:

  • application: informações referentes a application que você deseja criar, isto é: o nome dela e o tipo. O tipo da aplicação pode ser um dos seguintes valores: API, ORACLE ou PLUGIN.
  • name: O nome da sua application, facilita o processo de identificação da nova application.

Num exemplo prático, o body da sua requisição seguiria semelhante a este exemplo:

{
  "application": {
    "name": "MyAPIAccess",
    "type": "API",
  },
  "taxID": {
    "taxID": "65914571000187",
    "type": "BR:CNPJ",
  }
}

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, você estará vendo as informações sobre a application recém criada.

Num exemplo, essa será a resposta a nossa resposta:

{
  "application": {
    "name": "MyAPIAccess",
    "isActive": true,
    "type": "API",
    "clientId": "Client_Id_xxxx",
    "clientSecret": "Client_Secret_xxxx"
  }
}

Utilizando o appID​

Após criar sua nova application, você consegue obter seu AppID convertendo os valores de clientId e clientSecret para Base64. Segue um exemplo em JavaScript de como fazer isso:

const appID = Buffer.from(`${clientId}:${clientSecret}`, 'utf8').toString('base64');

O appID será o valor que você usará no header de Authorization para consumir as APIs Woovi.