# Codificar texto para URL

> Codifica um texto para usar numa URL, no formato de formulário: o espaço vira +, e os acentos e os outros caracteres especiais viram %XX.

Endereço: https://docs.nextags.com.br/referencia/ferramentas/codificar-texto-para-url/
Tipo: Endpoint

```http
POST https://app.nextagsai.com.br/api/tools/urlencode
X-ACCESS-TOKEN: <sua chave de API>
```

Codifica um texto para usar numa URL, no formato de formulário: o espaço vira `+`, e os acentos e os outros caracteres especiais viram `%XX`. Use no valor de um parâmetro, depois do `?`. Para `%20` no lugar do `+`, use [Codificar para URL (RFC 3986)](https://docs.nextags.com.br/referencia/ferramentas/codificar-para-url-rfc-3986/).

Autenticação: Mande a chave de API da conta no cabeçalho `X-ACCESS-TOKEN` de cada chamada. Veja [Autenticação com a chave de API](https://docs.nextags.com.br/comecar/autenticacao/).

## Corpo da requisição (formulário, application/x-www-form-urlencoded)

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `text` | string | sim | O texto. |

```json
{
  "text": "Olá, quero o pedido PED-1001"
}
```

## Exemplo

```bash
curl -X POST "https://app.nextagsai.com.br/api/tools/urlencode" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  --data-urlencode 'text=Olá, quero o pedido PED-1001'
```

Os exemplos em JavaScript, Python e PHP estão na página e no contrato (`x-codeSamples` em https://docs.nextags.com.br/openapi.json).

## Respostas

### 200 Sucesso

O texto codificado, em `data`.

| Campo | Tipo | Descrição |
|---|---|---|
| `data` | string | O texto codificado. |

```json
{
  "data": "Ol%C3%A1%2C+quero+o+pedido+PED-1001"
}
```

### 401 Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja [Autenticação](https://docs.nextags.com.br/comecar/autenticacao/).

```json
{
  "error": {
    "code": 401,
    "message": "No valid API key provided."
  }
}
```