GET/api/v2/partners/application

Listar Aplicações

Lista todas as aplicações cadastradas do parceiro autenticado.

Parâmetros

AuthorizationObrigatório
header

Token de autenticação obtido no login do parceiro.

Tipo:string

Cabeçalhos obrigatórios:

CabeçalhoValorDescrição
AuthorizationBearer {{ access_token }}Token de autenticação obtido no login do parceiro.

Campos principais do response

CampoTipoDescrição
dataarrayLista de aplicações do parceiro.
partnerobjectDados do parceiro relacionado à aplicação.
namestringNome da aplicação.
descriptionstringDescrição detalhada da aplicação.
briefingstringResumo ou objetivo da aplicação.
categorystringCategoria associada à aplicação.
scopesarrayEscopos autorizados para a aplicação.
statusstringStatus atual da aplicação (pending, active, etc).
created_atstringData de criação da aplicação (ISO8601).
updated_atstringData da última atualização da aplicação (ISO8601).
links e metaobjectInformações de paginação.

Status das Aplicações

StatusDescrição
pendingAplicação aguardando aprovação.
activeAplicação aprovada e ativa.
rejectedAplicação rejeitada.
suspendedAplicação suspensa temporariamente.

Observações

  • Para acessar esse endpoint, é obrigatório estar autenticado usando o access_token obtido no login do parceiro.
  • Utilize os parâmetros de paginação (page) conforme necessário para percorrer todas as aplicações.
  • Apenas aplicações do parceiro autenticado são retornadas.
  • Os campos client_id e client_secret só são preenchidos após aprovação da aplicação.

Códigos de Resposta

CódigoSignificadoDescrição
200OKLista de aplicações retornada com sucesso.
401UnauthorizedToken de autenticação inválido ou expirado.
500Internal Server ErrorErro interno do servidor.
curl --location 'https://dominio-ambiente.com.br/api/v2/partners/application' \
--header 'Authorization: Bearer {{ access_token }}'
const axios = require('axios');

const listApplications = async (token) => {
  try {
    const response = await axios.get('https://dominio-ambiente.com.br/api/v2/partners/application', {
      headers: {
        'Authorization': `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });

    console.log('Aplicações encontradas:', response.data.data.length);
    response.data.data.forEach(app => {
      console.log(`- ${app.name} (${app.status})`);
      console.log(`  Escopos: ${app.scopes.join(', ')}`);
    });
    
    return response.data;
    
  } catch (error) {
    console.error('Erro ao listar aplicações:', error.response?.data || error.message);
    return null;
  }
};

// Uso
const token = '{{ access_token }}';
listApplications(token);
import requests

def list_applications(token):
    url = "https://dominio-ambiente.com.br/api/v2/partners/application"
    
    headers = {
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json"
    }
    
    try:
        response = requests.get(url, headers=headers)
        response.raise_for_status()
        
        data = response.json()
        
        print(f"Aplicações encontradas: {len(data['data'])}")
        for app in data['data']:
            print(f"- {app['name']} ({app['status']})")
            print(f"  Escopos: {', '.join(app['scopes'])}")
        
        return data
        
    except requests.exceptions.RequestException as e:
        print(f"Erro na requisição: {e}")
        return None

# Uso
token = "{{ access_token }}"
result = list_applications(token)
<?php

function listApplications($token) {
    $url = 'https://dominio-ambiente.com.br/api/v2/partners/application';
    
    // Configuração do cURL
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'
    ]);
    
    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    $error = curl_error($ch);
    curl_close($ch);
    
    if ($error) {
        echo "Erro cURL: " . $error . "\n";
        return null;
    }
    
    if ($httpCode !== 200) {
        echo "Erro HTTP: " . $httpCode . "\n";
        echo "Resposta: " . $response . "\n";
        return null;
    }
    
    $data = json_decode($response, true);
    
    if (json_last_error() !== JSON_ERROR_NONE) {
        echo "Erro ao decodificar JSON: " . json_last_error_msg() . "\n";
        return null;
    }
    
    echo "Aplicações encontradas: " . count($data['data']) . "\n";
    
    foreach ($data['data'] as $app) {
        echo "- " . $app['name'] . " (" . $app['status'] . ")\n";
        echo "  Escopos: " . implode(', ', $app['scopes']) . "\n";
    }
    
    return $data;
}

// Uso
$token = '{{ access_token }}';
listApplications($token);
?>
{
  "data": [
    {
      "id": "abnks92-cb57-4ee3-a997-655fb5d0ea45",
      "partner": {
        "id": "981239kd-98d9-45d3-a1e0-eb24db30d22e",
        "cnpj": null,
        "name": "parceiro",
        "description": null,
        "logo": null,
        "website": null,
        "contact_email": "[email protected]",
        "contact_phone": "99999999999",
        "status": "pending",
        "scopes": [
          "dict.read",
          "webhooks.read",
          "terminals.read",
          "merchants.read",
          "merchants.write",
          "transactions.write",
          "transactions.read",
          "webhooks.write",
          "dict.write",
          "cob.write",
          "cob.read",
          "terminals.write"
        ]
      },
      "name": "Parceiro",
      "description": "Aplicacao do parceiro",
      "briefing": "Pix é com a nuvende!",
      "category": "Categoria 1",
      "scopes": [
        "cob.read",
        "cob.write"
      ],
      "client_id": null,
      "client_secret": null,
      "status": "pending",
      "created_at": "2025-07-07T14:25:57-03:00",
      "updated_at": "2025-07-07T14:25:57-03:00"
    }
  ],
  "links": {
    "first": "https://dominio-ambiente.com.br/api/v1/partners/application?page=1",
    "last": "https://dominio-ambiente.com.br/api/v1/partners/application?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Anterior",
        "active": false
      },
      {
        "url": "https://dominio-ambiente.com.br/api/v1/partners/application?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Próximo »",
        "active": false
      }
    ],
    "path": "https://dominio-ambiente.com.br/api/v1/partners/application",
    "per_page": 10,
    "to": 1,
    "total": 1
  }
}