Quando autenticar o usuário com OAuth2, você pode especificar quais dados o token terá acesso através da escolha de um ou mais escopos de acesso.
Escopos
Aqui está a lista de todos os escopos que você pode solicitar:
| Slug do Scope | Descrição em Português |
|---|---|
| login | Autenticação e login |
| admin.subaccounts | Administração de subcontas |
| admin.users | Administração de usuários |
| automation.email_accounts | Contas de e-mail para automação |
| automation.email_deliveries | Entregas de e-mail automatizadas |
| automation.sms_accounts | Contas de SMS para automação |
| automation.sms_deliveries | Entregas de SMS automatizadas |
| automation.webhook_deliveries | Entregas de webhooks automatizadas |
| automation.webhooks | Webhooks de automação |
| billing.transactions | Transações de cobrança |
| charge.automatic_pix.pix | PIX automático de cobrança |
| charge.automatic_pix.recurrences | Recorrências de PIX automático |
| charge.automatic_pix.requests | Solicitações de PIX automático |
| charge.bank_billet_accounts | Contas de boletos bancários |
| charge.bank_billet_payments | Pagamentos de boletos bancários |
| charge.bank_billet_registrations | Registros de boletos bancários |
| charge.bank_billets | Boletos bancários |
| charge.customer_subscriptions | Assinaturas de clientes |
| charge.installments | Parcelas de cobrança |
| charge.payments | Pagamentos de cobrança |
| charge.pix | PIX de cobrança |
| charge.pix_accounts | Contas PIX para cobrança |
| data.bank_billet_queries | Consultas de boletos bancários |
| crm.customers | Clientes CRM |
| crm.people | Pessoas CRM |
| financial.accounts | Contas financeiras |
| financial.balances | Saldos financeiros |
| financial.providers | Provedores financeiros |
| financial.statement_transactions | Transações de extrato financeiro |
| integration.certificates | Certificados de integração |
| integration.connections | Conexões de integração |
| integration.discharges | Baixas de integração |
| integration.edi_boxes | Caixas EDI de integração |
| integration.remittances | Remessas de integração |
| mailbox.entries | Entradas de caixa postal |
| mailbox.files | Arquivos de caixa postal |
| partner.bank_contracts | Contratos bancários de parceiros |
| payment.bank_billets | Boletos bancários para pagamento |
| payment.batches | Lotes de pagamento |
| payment.darfs | DARFs (Documento de Arrecadação de Receitas Federais) |
| payment.pix | Pagamentos PIX |
| payment.taxes | Pagamento de impostos |
| payment.utilities | Pagamento de contas de consumo |
| security.access_tokens | Tokens de acesso de segurança |
| system.events | Eventos do sistema |
| system.imports | Importações do sistema |
| system.reports | Relatórios do sistema |
| transfer.batches | Lotes de transferência |
| transfer.internal | Transferências internas |
| transfer.pix | Transferências PIX |
| transfer.ted | Transferências TED (Transferência Eletrônica Disponível) |
OAuth2
Para OAuth2, permissões são acessadas através do parâmetro scope em sua requisição OAuth2.
Por exemplo, sua aplicação pode precisar logar como o usuário para gerar boletos, porém não precisará saber quais são os dados bancários do usuário.
A permissão padrão é login caso você não especifice um scope.
Grupo de permissões
Você pode solicitar permissões individuais ou em grupo.
Permissões em grupo devem ser separadas com caracter + na URL.
Abaixo um exemplo de URL de requisição com parâmetro scope no final:
https://api-sandbox.kobana.com.br/v1/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_CALLBACK_URL&scope=login+email+profile