# `ApiKey`

A key for an API: up to 512 characters with no spaces.

Use it for a key someone sends you or that you send to a service. Keep `hash.sha256` of it, not the key. For a token after `Bearer`, use [`BearerToken`](/docs/types/type-bearer-token.md).

## Shape

One secret value, with no parts.

## Example

```jadpo
ApiKey("example_key_0123456789abcdef")
```

In a real app it arrives from outside, such as in a request, rather than as text you write in your code.

`text.parse(raw, as: ApiKey)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `example key` or `exämple_key`.

## Good to know

- It is never sent, logged, stored or shown.
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string when it arrives, and written redacted when it leaves, in a request, a response or `json.write`:

```json
"<redacted ApiKey>"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`ApiKey` is in the group Security, and has been in Jadpo since 0.1.0.

### Text form

`text.parse` reads one from its text as it is typed. `text.from` and `text.format` don't take it, so nothing writes it.

### How it is stored

It is never stored.

### How it is shown to people

`text.format` doesn't take it: a `ApiKey` is never shown.

### Operations

It also takes `text.parse`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>