Cria uma nova aplicação vinculada ao parceiro autenticado.
Token de autenticação obtido no login do parceiro.
stringCabeçalhos obrigatórios:
| Cabeçalho | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo enviado no corpo da requisição. |
Authorization | Bearer {{ access_token }} | Token de autenticação obtido no login do parceiro. |
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da aplicação. |
scopes | array | Sim | Lista de escopos autorizados para a aplicação. |
description | string | Sim | Descrição detalhada da aplicação. |
briefing | string | Sim | Descrição resumida da aplicação. |
category | string | Sim | Categoria atribuída à aplicação. |
| Escopo | Descrição |
|---|---|
cob.read | Leitura de cobranças Pix |
cob.write | Criação e atualização de cobranças Pix |
merchants.read | Leitura de estabelecimentos |
merchants.write | Criação e atualização de estabelecimentos |
terminals.read | Leitura de terminais |
terminals.write | Criação e atualização de terminais |
transactions.read | Leitura de transações |
transactions.write | Criação e atualização de transações |
webhooks.read | Leitura de webhooks |
webhooks.write | Criação e atualização de webhooks |
dict.read | Leitura de dicionários |
dict.write | Criação e atualização de dicionários |
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID único da aplicação criada. |
partner | object | Dados do parceiro proprietário da aplicação. |
name | string | Nome da aplicação. |
description | string | Descrição detalhada da aplicação. |
briefing | string | Descrição resumida da aplicação. |
category | string | Categoria atribuída à aplicação. |
scopes | array | Escopos autorizados para a aplicação. |
client_id | string | ID do cliente (gerado após aprovação). |
client_secret | string | Chave secreta do cliente (gerada após aprovação). |
status | string | Status atual da aplicação (pending inicialmente). |
created_at | string | Data de criação da aplicação (ISO8601). |
updated_at | string | Data da última atualização da aplicação (ISO8601). |
| Status | Descrição |
|---|---|
pending | Aplicação aguardando aprovação (status inicial). |
active | Aplicação aprovada e ativa. |
rejected | Aplicação rejeitada. |
suspended | Aplicação suspensa temporariamente. |
{{ access_token }} deve ser obtido previamente através do endpoint de login do parceiro.scopes definem as permissões que a aplicação terá dentro do ambiente.pending até ser aprovada pelo time responsável.client_id e client_secret só são gerados após aprovação da aplicação.| Código | Significado | Descrição |
|---|---|---|
| 201 | Created | Aplicação criada com sucesso. |
| 400 | Bad Request | Parâmetros inválidos ou ausentes na requisição. |
| 401 | Unauthorized | Token de autenticação inválido ou expirado. |
| 403 | Forbidden | Parceiro não tem permissão para criar aplicações. |
| 500 | Internal Server Error | Erro interno do servidor. |
Em caso de sucesso, será retornado um objeto JSON com os dados da aplicação criada, semelhante ao exemplo de listagem, contendo id, name, scopes, status, datas e informações do parceiro.
curl --location 'https://dominio-ambiente.com.br/api/v2/partners/application' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ access_token }}' \
--data '{
"name": "Nome da sua aplicação",
"scopes": [
"cob.read",
"cob.write"
],
"description": "Uma descrição da sua aplicação",
"briefing": "Uma descrição curta da sua aplicação",
"category": "Categoria 1"
}'
const axios = require('axios');
const createApplication = async (token, applicationData) => {
try {
const response = await axios.post('https://dominio-ambiente.com.br/api/v2/partners/application', applicationData, {
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
}
});
console.log('Aplicação criada:', response.data.id);
console.log('Nome:', response.data.name);
console.log('Status:', response.data.status);
return response.data;
} catch (error) {
console.error('Erro ao criar aplicação:', error.response?.data || error.message);
return null;
}
};
// Exemplo de uso
const applicationData = {
name: "Nome da sua aplicação",
scopes: ["cob.read", "cob.write"],
description: "Uma descrição da sua aplicação",
briefing: "Uma descrição curta da sua aplicação",
category: "Categoria 1"
};
const token = "{{ access_token }}";
createApplication(token, applicationData);
import requests
import json
def create_application(token, application_data):
url = "https://dominio-ambiente.com.br/api/v2/partners/application"
headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {token}"
}
try:
response = requests.post(url, json=application_data, headers=headers)
response.raise_for_status()
data = response.json()
print(f"Aplicação criada: {data['id']}")
print(f"Nome: {data['name']}")
print(f"Status: {data['status']}")
print(f"Escopos: {', '.join(data['scopes'])}")
return data
except requests.exceptions.RequestException as e:
print(f"Erro na requisição: {e}")
return None
# Exemplo de uso
application_data = {
"name": "Nome da sua aplicação",
"scopes": ["cob.read", "cob.write"],
"description": "Uma descrição da sua aplicação",
"briefing": "Uma descrição curta da sua aplicação",
"category": "Categoria 1"
}
token = "{{ access_token }}"
result = create_application(token, application_data)
<?php
function createApplication($token, $applicationData) {
$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_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($applicationData));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Authorization: Bearer ' . $token
]);
$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 && $httpCode !== 201) {
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ção criada: " . $data['id'] . "\n";
echo "Nome: " . $data['name'] . "\n";
echo "Status: " . $data['status'] . "\n";
return $data;
}
// Exemplo de uso
$applicationData = [
'name' => 'Nome da sua aplicação',
'scopes' => ['cob.read', 'cob.write'],
'description' => 'Uma descrição da sua aplicação',
'briefing' => 'Uma descrição curta da sua aplicação',
'category' => 'Categoria 1'
];
$token = '{{ access_token }}';
createApplication($token, $applicationData);
?>
{
"id": "app-123-456-789",
"partner": {
"id": "partner-abc-def",
"name": "Minha Empresa",
"contact_email": "[email protected]",
"contact_phone": "11999999999",
"status": "active",
"scopes": ["cob.read", "cob.write", "merchants.read"]
},
"name": "Nome da sua aplicação",
"description": "Uma descrição da sua aplicação",
"briefing": "Uma descrição curta da sua aplicação",
"category": "Categoria 1",
"scopes": [
"cob.read",
"cob.write"
],
"client_id": null,
"client_secret": null,
"status": "pending",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}