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

# Introdução

Para começar a utilizar a API do Procfy, você precisará de um token de API. Os tokens de API permitem que o Procfy rastreie o uso de sua API por token.

Os tokens de API são únicas para cada conta e podem ser gerenciadas pelo painel api tokens.

Cada token possui um conjunto de permissões que determinam quais recursos da API ela pode acessar. Por exemplo, uma token pode ter permissão para criar e excluir documentos, mas não para criar ou excluir contatos. Você pode gerenciar essas permissões no painel api tokens.

<Note>
  O único que pode criar o token de API é o administrador da conta.
</Note>

<Card title="Aviso importante" type="warning">
  O acesso à API não é liberado automaticamente. Para começar a utilizá-la, é necessário primeiro entrar em contato com o nosso time de atendimento para solicitar a liberação do recurso na sua conta. Chame nosso atendimento via [WhatsApp](https://api.whatsapp.com/send?phone=5546999410460).
</Card>

***

## **Criando um token de API**

Para criar um token de API clique no seu nome no canto superior esquerdo da tela e selecione **Configurações da Conta**.

<Frame>
  <img src="https://mintcdn.com/procfy/fI-HfK2moeiqsyH4/images/click_api_token-e562e2f9.png?fit=max&auto=format&n=fI-HfK2moeiqsyH4&q=85&s=7d628ee88ccb4f8c8d4cea551f2f8cd2" alt="Click Api Token" width="265" height="574" data-path="images/click_api_token-e562e2f9.png" />
</Frame>

Após acessar as Configurações da Conta, selecione a opção **Tokens da API**

<Frame>
  <img src="https://mintcdn.com/procfy/fI-HfK2moeiqsyH4/images/click_api_tab-7747ee13.png?fit=max&auto=format&n=fI-HfK2moeiqsyH4&q=85&s=449efb97e005ae63f3253832039281a9" alt="Click Api Tab" width="1512" height="533" data-path="images/click_api_tab-7747ee13.png" />
</Frame>

Ao acessar a tela de **Tokens da API** pela primeira vez, você verá uma imagem semelhante a esta:

<Frame>
  <img src="https://mintcdn.com/procfy/fI-HfK2moeiqsyH4/images/api_token_empty-66ad755a.png?fit=max&auto=format&n=fI-HfK2moeiqsyH4&q=85&s=784fd4fe24bd1cb9e44f3cbe867e7cf9" alt="Api Token Empty" width="1149" height="293" data-path="images/api_token_empty-66ad755a.png" />
</Frame>

Para criar um novo token de API, clique no botão **Adicionar**.

***

## **Configurando um token de API**

Ao clicar no botão **Adicionar**, você verá uma imagem semelhante a esta:

<Frame>
  <img src="https://mintcdn.com/procfy/fI-HfK2moeiqsyH4/images/api_token_add-853aa935.png?fit=max&auto=format&n=fI-HfK2moeiqsyH4&q=85&s=45e3d18bdde7b22ed9d0b3d4194f7de4" alt="Api Token Add" width="993" height="453" data-path="images/api_token_add-853aa935.png" />
</Frame>

Nessa interface, é possível personalizar o nome do token de API, incluir uma descrição, se desejado e definir a duração do token. Após concluir a configuração do token de API, basta clicar no botão **Criar Api Token** para aplicar as configurações.

***

## **Visualizando um token de API**

Após acessar as Configurações da Conta, e selecionar a opção **Tokens da API**, você verá uma imagem semelhante a esta:

<Frame>
  <img src="https://mintcdn.com/procfy/fI-HfK2moeiqsyH4/images/api_token_view-42ca4349.png?fit=max&auto=format&n=fI-HfK2moeiqsyH4&q=85&s=7b4d67dc8fc2eff28f439be5aede3d0c" alt="Api Token View" width="1097" height="214" data-path="images/api_token_view-42ca4349.png" />
</Frame>

Nessa tela, é possível visualizar o nome do token de API, verificar seu status de ativação, consultar a última vez que foi utilizada e conferir a descrição. Para visualizar o token, basta clicar na seta localizada no canto direito da tela.

Ao clicar na seta, você verá uma imagem semelhante a esta:

<Frame>
  <img src="https://mintcdn.com/procfy/fI-HfK2moeiqsyH4/images/api_token_view_token-93076f3f.png?fit=max&auto=format&n=fI-HfK2moeiqsyH4&q=85&s=36a74c1412008e4c38cde09c589b7545" alt="Api Token View Token" width="1152" height="143" data-path="images/api_token_view_token-93076f3f.png" />
</Frame>

Nessa tela, você pode visualizar a chave vinculada ao token de API. Para copiá-la, simplesmente clique no botão **Copiar**. Se desejar editar o token de API, utilize o botão **Editar**. Além disso, é possível excluir o token de API clicando no botão **Excluir**.