curl -X POST 'https://api.goatpay.com.br/v1/oauth-apps/clients/ensure/clx_app_01/DEV' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Credenciais OAuth configuradas com sucesso",
"data": {
"client": {
"id": "clx_client_dev",
"environment": "DEV",
"clientId": "gp_oauth_dev_f328edfa60b7949ab61c55f6a285dfc3",
"clientSecretPreview": "gp_oauth_dev_...****",
"status": "ACTIVE",
"redirectUris": []
},
"clientSecret": "gp_oauth_dev_b5800853ddc06cd9f89ed43f58f95da2073a8282f52eafc5"
},
"requestId": "req_oauth_ensure"
}
{
"success": true,
"message": "Credenciais OAuth configuradas com sucesso",
"data": {
"client": {
"id": "clx_client_dev",
"environment": "DEV",
"clientId": "gp_oauth_dev_f328edfa60b7949ab61c55f6a285dfc3",
"clientSecretPreview": "gp_oauth_dev_...****",
"redirectUris": []
},
"clientSecret": null
},
"requestId": "req_oauth_ensure"
}
Gestão
Gerar credenciais do client
Cria client DEV ou PRODUCTION. clientSecret só na primeira criação.
POST
/
oauth-apps
/
clients
/
ensure
/
{applicationId}
/
{environment}
curl -X POST 'https://api.goatpay.com.br/v1/oauth-apps/clients/ensure/clx_app_01/DEV' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Credenciais OAuth configuradas com sucesso",
"data": {
"client": {
"id": "clx_client_dev",
"environment": "DEV",
"clientId": "gp_oauth_dev_f328edfa60b7949ab61c55f6a285dfc3",
"clientSecretPreview": "gp_oauth_dev_...****",
"status": "ACTIVE",
"redirectUris": []
},
"clientSecret": "gp_oauth_dev_b5800853ddc06cd9f89ed43f58f95da2073a8282f52eafc5"
},
"requestId": "req_oauth_ensure"
}
{
"success": true,
"message": "Credenciais OAuth configuradas com sucesso",
"data": {
"client": {
"id": "clx_client_dev",
"environment": "DEV",
"clientId": "gp_oauth_dev_f328edfa60b7949ab61c55f6a285dfc3",
"clientSecretPreview": "gp_oauth_dev_...****",
"redirectUris": []
},
"clientSecret": null
},
"requestId": "req_oauth_ensure"
}
Permissão:
oauth-apps/clients/ensure.
curl -X POST 'https://api.goatpay.com.br/v1/oauth-apps/clients/ensure/clx_app_01/DEV' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Credenciais OAuth configuradas com sucesso",
"data": {
"client": {
"id": "clx_client_dev",
"environment": "DEV",
"clientId": "gp_oauth_dev_f328edfa60b7949ab61c55f6a285dfc3",
"clientSecretPreview": "gp_oauth_dev_...****",
"status": "ACTIVE",
"redirectUris": []
},
"clientSecret": "gp_oauth_dev_b5800853ddc06cd9f89ed43f58f95da2073a8282f52eafc5"
},
"requestId": "req_oauth_ensure"
}
{
"success": true,
"message": "Credenciais OAuth configuradas com sucesso",
"data": {
"client": {
"id": "clx_client_dev",
"environment": "DEV",
"clientId": "gp_oauth_dev_f328edfa60b7949ab61c55f6a285dfc3",
"clientSecretPreview": "gp_oauth_dev_...****",
"redirectUris": []
},
"clientSecret": null
},
"requestId": "req_oauth_ensure"
}
Parâmetros
string
required
ID da aplicação OAuth.
string
required
DEV ou PRODUCTION. Credenciais são independentes por ambiente.Guarde o
clientSecret imediatamente — exibido uma vez na criação. Use regenerar secret para rotacionar.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
Available options:
DEV, PRODUCTION