> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar credenciais de API da plataforma AceDataCloud

> Platform API guide - Ace Data Cloud

Crie credenciais de API de negócio para uma Application. A resposta de criação pode incluir um Token que pode chamar diretamente `https://api.acedata.cloud/**`, ou nome de usuário/senha de credenciais do tipo Proxy; devem ser tratados como segredos.

## Preparação

1. Crie um [Account Token](https://platform.acedata.cloud/documents/platform-token).
2. Obtenha o `application_id` que você possui na [lista de Applications](https://platform.acedata.cloud/documents/platform-application-list).

```shell theme={null}
export PLATFORM_TOKEN='seu token de conta'
export APPLICATION_ID='seu ID de Application'
```

## Visão geral da interface

| Item | Conteúdo |
| - | - |
| Método | `POST` |
| URL | `https://platform.acedata.cloud/api/v1/credentials/` |
| Autenticação | Account Token, o token OAuth requer `credentials:write` |
| Body | JSON |

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `application_id` | UUID | Sim | Application de destino |
| `name` | string | Não | Nome de exibição da credencial |
| `limited_amount` | number / null | Não | Limite de uso por credencial; `null` indica não definir um limite independente |
| `expired_at` | datetime / null | Não | Horário de expiração ISO 8601 |
| `allowed_api_ids` | UUID\[] / null | Não | Permite chamar apenas estas APIs; um array vazio será normalizado como sem restrição |
| `host` | string | Não | Informações de host da credencial |
| `for_user_id` | string | Não | Usado quando o proprietário da Application emite credenciais autorizadas para outro usuário |
| `tags` / `metadata` | array / object | Não | Dados de extensão personalizados |

```shell theme={null}
curl -X POST 'https://platform.acedata.cloud/api/v1/credentials/' \
  -H "Authorization: Bearer ${PLATFORM_TOKEN}" \
  -H 'Content-Type: application/json' \
  -d "{\"application_id\":\"${APPLICATION_ID}\",\"name\":\"production\",\"limited_amount\":50}"
```

## Descrição da resposta

Em caso de sucesso, retorna `201` e o objeto Credential:

* Serviços do tipo API/Agent geralmente retornam `type=Token` e `token`;
* Serviços do tipo Proxy geralmente retornam `type=Identity` e `username` / `password`, e uma Proxy Application permite apenas uma credencial;
* `id`, `user_id`, `creator_id`, `used_amount` e os campos de tempo são gerados pelo servidor.

As interfaces atuais de lista e detalhes também retornam a credencial em texto simples, mas o cliente não deve depender desse comportamento histórico. Salve-a imediatamente após a criação, evite gravar a resposta em logs; futuras interfaces podem passar a retornar dados mascarados.

## Tratamento de erros

* `400`: Formato de campo incorreto, `allowed_api_ids` desconhecidos, a Proxy Application já possui credenciais ou outras restrições de criação.
* `401`: Account Token inválido.
* `403/404`: Sem permissão para acessar a Application de destino, ou a Application/usuário autorizado não existe.

## Próximos passos

* [Obter lista de credenciais de API](https://platform.acedata.cloud/documents/platform-credential-list)
* [Rotacionar credenciais de API](https://platform.acedata.cloud/documents/platform-credential-rotate)
* [Excluir credenciais de API](https://platform.acedata.cloud/documents/platform-credential-delete)
* [Ver registros de chamadas](https://platform.acedata.cloud/documents/platform-usage-list)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.