# Criar chave de API

> Criar chave de API: POST /v1/api-keys. Cria uma chave. O segredo aparece UMA vez, na resposta.

Fonte: https://praeko.app/docs/api/api-keys/create-api-key

`POST /v1/api-keys` · escopo mínimo: admin

Cria uma chave. O segredo aparece UMA vez, na resposta.

> **Cabeçalhos** `Authorization: Bearer praeko_…` e `X-Praeko-Contract: en`. Sempre envie os dois.

Alias antigo em português (continua respondendo, marcado como obsoleto): `/v1/chaves`.

## Parâmetros

| Nome | Onde | Descrição |
|---|---|---|
| `Idempotency-Key` | cabeçalho | Chave de idempotência (1 a 255 caracteres visíveis, por exemplo um UUID). Repetir o MESMO pedido com a mesma chave, em até 24 h, devolve a resposta guardada (com `Idempotent-Replayed: true`) sem executar de novo; outro pedido com a mesma chave dá 422 `idempotency_key_reuse`; um pedido ainda em andamento dá 409 `idempotency_in_progress`. Erros 5xx não são guardados. A chave vale por workspace e por rota. Veja [Repetir uma requisição](https://praeko.app/docs/guides/idempotency). |

## Corpo da requisição

JSON. Campos obrigatórios precisam ir; os outros podem ser omitidos.

| Campo | Tipo | Descrição |
|---|---|---|
| `name` (obrigatório) | texto | Nome para você reconhecer a chave. 1 a 60 caracteres. |
| `scope` (opcional) | texto | Escopo da chave (cada nível inclui o anterior). Valores: read, write, admin; padrão: write. |
| `expiresInDays` (opcional) | inteiro | Validade em dias. Sem ele a chave não expira. De 1 a 365. |

**Exemplo de corpo**

```json
{
  "name": "automação do roteiro",
  "scope": "write",
  "expiresInDays": 90
}
```

## Exemplo

**curl**

```bash
curl -X POST "https://praeko.app/v1/api-keys" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "automação do roteiro",
  "scope": "write",
  "expiresInDays": 90
}'
```

**JavaScript**

```js
const res = await fetch("https://praeko.app/v1/api-keys", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.PRAEKO_KEY}`,
    "X-Praeko-Contract": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "automação do roteiro",
    "scope": "write",
    "expiresInDays": 90
  }),
});
console.log(res.status, await res.json());
```

**Node**

```js
import { Praeko } from "@praeko/sdk";

const praeko = new Praeko({ url: "https://praeko.app", key: process.env.PRAEKO_KEY });
const resultado = await praeko.apiKeys.create("automação do roteiro", "write", 90);
console.log(resultado);
```

**Python**

```python
import os
import requests

resp = requests.post(
    "https://praeko.app/v1/api-keys",
    headers={
        "Authorization": f"Bearer {os.environ['PRAEKO_KEY']}",
        "X-Praeko-Contract": "en",
    },
    json={
        "name": "automação do roteiro",
        "scope": "write",
        "expiresInDays": 90,
    },
)
print(resp.status_code, resp.json())
```

**PHP**

```php
<?php
$corpo = <<<'JSON'
{
  "name": "automação do roteiro",
  "scope": "write",
  "expiresInDays": 90
}
JSON;

$ch = curl_init('https://praeko.app/v1/api-keys');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("PRAEKO_KEY"),
        'X-Praeko-Contract: en',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $corpo,
]);
$resposta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $resposta, PHP_EOL;
curl_close($ch);
```

**Go**

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "name": "automação do roteiro",
  "scope": "write",
  "expiresInDays": 90
}`)
	req, err := http.NewRequest("POST", "https://praeko.app/v1/api-keys", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PRAEKO_KEY"))
	req.Header.Set("X-Praeko-Contract", "en")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	out, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(out))
}
```

**Ruby**

```ruby
require "net/http"
require "uri"

uri = URI("https://praeko.app/v1/api-keys")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV['PRAEKO_KEY']}"
request["X-Praeko-Contract"] = "en"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "name": "automação do roteiro",
    "scope": "write",
    "expiresInDays": 90
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, response.body
```

**C#**

```csharp
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://praeko.app/v1/api-keys");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PRAEKO_KEY"));
request.Headers.Add("X-Praeko-Contract", "en");
request.Content = new StringContent("""
    {
      "name": "automação do roteiro",
      "scope": "write",
      "expiresInDays": 90
    }
""", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
```

**Java**

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "name": "automação do roteiro",
              "scope": "write",
              "expiresInDays": 90
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://praeko.app/v1/api-keys"))
            .header("Authorization", "Bearer " + System.getenv("PRAEKO_KEY"))
            .header("X-Praeko-Contract", "en")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
```

**HTTPie**

```bash
http POST "https://praeko.app/v1/api-keys" \
  "Authorization: Bearer $PRAEKO_KEY" \
  "X-Praeko-Contract: en" \
  "Content-Type: application/json" \
  --raw='{
  "name": "automação do roteiro",
  "scope": "write",
  "expiresInDays": 90
}'
```

> SDK oficial para Node: Instale com `npm install @praeko/sdk` (veja [SDK e CLI](https://praeko.app/docs/sdk)).

## Resposta

| Status de sucesso | Quando |
|---|---|
| `200` | Sucesso. |

**Resposta 200**

```json
{
  "id": "01KA3Y1B9E5MK7PR3XD0V4SN2G",
  "name": "automação do roteiro",
  "scope": "write",
  "prefix": "praeko_8vN2xQe",
  "expiresAt": "2027-02-05T14:02:11.482Z",
  "key": "praeko_8vN2xQe4L1mTz7Hc0Yb5Wd3KfRj6PaUo9GtSi2XnVEwqLs",
  "warning": "guarde esta chave agora: ela não aparece de novo"
}
```

## Erros

| Status | code | Quando |
|---|---|---|
| 400 | `empty_body` | O corpo veio vazio. |
| 400 | `invalid_json` | O corpo não é um objeto JSON. |
| 413 | `body_too_large` | O corpo passa de 1 MB. |
| 422 | `invalid_field` | `name` ausente, `scope` desconhecido ou `expiresInDays` fora de 1 a 365. |
| 422 | `idempotency_key_reuse` | A `Idempotency-Key` já foi usada com outro pedido (método, caminho, query ou corpo diferentes). |
| 409 | `idempotency_in_progress` | Um pedido com a mesma `Idempotency-Key` ainda está em andamento (repita em instantes). |
| 409 | `idempotency_response_too_large` | A resposta original passou de 256 KB e não foi guardada; consulte o recurso por GET. |

### Erros de qualquer rota

| Status | code | Quando |
|---|---|---|
| 401 | `unauthorized` | Faltou o cabeçalho `Authorization: Bearer …`. |
| 401 | `invalid_api_key` | A chave não existe. |
| 401 | `revoked_api_key` | A chave foi revogada. |
| 401 | `expired_api_key` | A chave expirou. |
| 403 | `forbidden` | O escopo da chave não basta para esta rota (veja o selo de escopo). |
| 429 | `rate_limited` | Passou do limite de requisições por minuto. |

O corpo de todo erro é `{ "error": { "code", "message", "details"? } }`. Veja [todos os códigos](https://praeko.app/docs/guides/errors-and-limits).

## Testar

> **Testar**: o teste ao vivo exige entrar na conta. Aqui ele fica desligado.
