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

# Coleção do Postman

> Importe a coleção do Postman gerada para a API Pública da Living Security, cole uma chave de API e chame /v1 em minutos.

A coleção do Postman da API v1 da Living Security é gerada a partir da mesma
especificação OpenAPI que alimenta a [Referência da API v1](/v1-reference/openapi-v1.json),
portanto sempre corresponde ao contrato publicado. Ela abrange todas as operações `/v1`,
agrupadas por recurso, com a autenticação previamente configurada.

## Download

<Info>
  Os links de download solicitam que você faça login com sua conta da Living Security
  antes de o arquivo ser disponibilizado.
</Info>

<CardGroup cols={1}>
  <Card title="Coleção da API v1 da Living Security" icon="download">
    Postman Collection v2.1 com todas as operações `/v1` e a autenticação Basic
    previamente configurada. A coleção `baseUrl` está em branco — selecione um
    ambiente regional antes de enviar uma requisição.

    <a href="/v1-reference/postman/living-security-api-v1.postman_collection.json" download="living-security-api-v1.postman_collection.json">Baixar a coleção</a>
  </Card>

  <Card title="Ambiente de produção (EUA)" icon="download">
    `baseUrl` predefinido como `https://api.us-east-1.livingsecurity.ai/v1`, com
    as variáveis `apiKeySecret` e `contractVersion` vazias para preenchimento.

    <a href="/v1-reference/postman/living-security-production.postman_environment.json" download="living-security-production.postman_environment.json">Baixar o ambiente de produção dos EUA</a>
  </Card>

  <Card title="Ambiente de produção (UE)" icon="download">
    `baseUrl` predefinido como `https://api.eu-west-1.livingsecurity.ai/v1`, com
    as variáveis `apiKeySecret` e `contractVersion` vazias para preenchimento.

    <a href="/v1-reference/postman/living-security-production-eu.postman_environment.json" download="living-security-production-eu.postman_environment.json">Baixar o ambiente de produção da UE</a>
  </Card>

  <Card title="Modelo de ambiente" icon="download">
    As mesmas variáveis com `baseUrl` em branco, para configurações que não sejam de produção.

    <a href="/v1-reference/postman/living-security-environment-template.postman_environment.json" download="living-security-environment-template.postman_environment.json">Baixar o modelo de ambiente</a>
  </Card>
</CardGroup>

## Configuração no Postman

<Steps>
  <Step title="Importe os arquivos">
    No Postman, escolha **Importação** e solte o arquivo da coleção junto com o
    ambiente de produção (EUA) ou de produção (UE) que corresponda à
    organização. Consulte [Regiões](/pt-BR/developers/v1/regions).
  </Step>

  <Step title="Crie uma chave de API">
    No Painel, abra **Configurações → Integrações & Developers →
    Developer Hub**, crie uma conta de serviço e crie uma chave de API. O segredo da chave começa com `lsk_live_` e
    é exibido apenas uma vez — copie-o imediatamente. Consulte
    [Chaves de API](/pt-BR/developers/developer-hub/api-keys) para obter detalhes.
  </Step>

  <Step title="Cole o segredo">
    Defina a variável `apiKeySecret` — no ambiente importado
    (recomendado; é uma variável do tipo secreto) ou na guia
    **Variáveis** da coleção.
  </Step>

  <Step title="Envie uma requisição">
    Selecione o ambiente regional importado, abra qualquer requisição — por exemplo,
    **Organização → Retrieve the organization** — e clique em **Enviar**. Não
    envie nada até que um ambiente seja selecionado; o valor `baseUrl` da coleção está em branco
    propositalmente.
  </Step>
</Steps>

## Como a autenticação é previamente configurada

A coleção define a autenticação Basic no nível da coleção, com o nome de usuário `apikey`
e a senha `{{apiKeySecret}}`. A API aceita o segredo da chave em qualquer um dos
campos de autenticação Basic, portanto isso funciona sem alterações assim que a variável for definida.

Se preferir a autenticação bearer, altere o tipo de **Authorization** da coleção
para **Bearer Token** e use `{{apiKeySecret}}` como token — a API
aceita o mesmo segredo nos dois formatos.

Usar um cabeçalho Bearer com uma chave de API não exige OAuth. Para usar OAuth,
defina **Bearer Token** como seu token de acesso OAuth, em vez do segredo da chave de API.
Consulte [Autenticação](/pt-BR/developers/v1/authentication) para escolher um método e
[Credenciais de cliente OAuth](/pt-BR/developers/v1/oauth) para a configuração de token e cliente.

## Cabeçalho de versão do contrato

Toda requisição inclui um cabeçalho `Living-Security-Version` predefinido como
`{{contractVersion}}`, desativado por padrão. Deixe-o desativado para usar a versão de contrato
fixada da sua organização. Ative-o para fixar a requisição em uma
versão publicada específica — consulte o [changelog](/pt-BR/developers/v1/changelog)
para ver as versões publicadas.

## Parâmetros de consulta e corpos

Os filtros dos endpoints de listagem (`limit`, `page_token` e filtros específicos de cada recurso)
estão incluídos em cada requisição, porém desativados, de modo que uma importação recém-feita chame todos os
endpoints com sucesso. Ative e preencha os que você precisar — consulte
[Paginação](/pt-BR/developers/v1/pagination) para saber como funciona `page_token`. Os corpos
de requisição das operações `POST` vêm preenchidos com valores de espaço reservado tipados.

<Note>
  A coleção é gerada novamente a partir da especificação OpenAPI publicada a cada alteração
  de contrato — baixe uma cópia atualizada em vez de editar as requisições que
  você deseja manter atualizadas.
</Note>


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