# Credenciais Antes de começar a consumir a API da Conta Azul, siga estes passos essenciais para configurar seu ambiente de desenvolvimento. ## 1. Crie sua conta de desenvolvedor Primeiro, crie uma conta no Gerenciador de Aplicações da Conta Azul. Essa conta permite que você gerencie todas as suas aplicações integradas a Conta Azul. Seja seu objetivo criar um **app público** (utilizado por diversos clientes) ou um **app privado** (exclusivamente para uso próprio), será necessário ter uma conta registrada. 🎥 Se preferir, acompanhe o vídeo abaixo, que apresenta de forma prática as etapas descritas nesta seção. div iframe ### Como realizar o login Siga os passos abaixo para acessar sua conta: 1. **Digite** seu e-mail cadastrado no campo **Email**. 2. **Insira** sua senha de acesso no campo **Senha**. 3. **Clique** em **Entrar**. ### 💡 Dicas - Caso ainda **não tenha uma conta**, clique em **Cadastre sua conta**. - Se **esqueceu sua senha**, utilize o link **Esqueceu sua senha?** para redefinir. ### ⚠️ Atenção Se você já é cliente **Conta Azul Pro**, utilize o **mesmo usuário e senha** cadastrados. Caso não se lembre da senha, basta recuperá-la através da opção **Esqueceu sua senha?**. ### Criação de cadastro (se aplicável) Siga as etapas abaixo para criar sua conta: 1. **Preencha** os campos obrigatórios: - **Email** - **Nome completo** - **Celular/WhatsApp** (com DDD) - **Crie sua senha de acesso** - **Confirme sua senha de acesso** 2. **Clique** em **Criar conta** para prosseguir. Após criar sua conta, um **código de verificação (PIN)** será enviado para o e-mail informado (expiração de 10 minutos). 3. **Acesse seu e-mail** e verifique a mensagem de confirmação. 4. **Digite o código de 6 dígitos** no campo de verificação exibido na tela. 5. **Conclua a validação** clicando em **Confirmar**. ### 💡 Dicas - Verifique se todas as informações estão corretas antes de finalizar o cadastro — especialmente o **e-mail** e o **número de celular**, pois serão utilizados para validação e recuperação de acesso. - Verifique a **pasta de spam** ou **lixo eletrônico** caso o e-mail de confirmação não apareça na sua caixa de entrada. - Certifique-se de que o endereço de e-mail informado está correto antes de solicitar novo envio. - Não compartilhe o código de verificação com outras pessoas. ## Questionário de perfil e intenção de integração Nesta etapa, você preencherá um breve questionário para entendermos melhor o seu perfil e o objetivo da sua integração. Após preencher o questionário, clique em **Concluir** para finalizar a configuração inicial da sua conta. Em seguida, você será direcionado para a **criação da sua primeira aplicação de desenvolvimento.** ## 2. Crie uma nova aplicação Após efetuar o login no Portal do Desenvolvedor, caso você não seja direcionado automaticamente, você poderá seguir os passos abaixo: - Clique em **"Criar uma aplicação"**. - Selecione qual aplicação deseja criar - Desenvolvimento ou Produção - Você será direcionado para etapas de criação do seu app. - Essas etapas fornecerão as informações essenciais para que você possa realizar as validações e testes necessários. 🎥 Se preferir, acompanhe o vídeo abaixo, que apresenta de forma prática as etapas descritas nesta seção. div iframe ### 💡 Dicas - Para a criação de aplicação de Desenvolvimento, utilizamos como URL de testes **https://www.contaazul.com**. Para o processo de Produção, será necessário que você indique a sua URL de redirecionamento para capturar as informações necessárias para o processo de Autenticação. - Se tiver dúvidas sobre o processo de Autenticação, consulte guia completo sobre o [fluxo OAuth2 e autenticação](/auth) - A criação de aplicação de Desenvolvimento, fornecerá dados ficticios para apoio durante o desenvolvimento. ## 3. Obtenha suas credenciais Ao concluir a criação da aplicação, serão exibidas duas informações importantes: - **`client_id`** - **`client_secret`** Essas credenciais são essenciais para o processo de autenticação OAuth2 e são necessárias para gerar o **`access_token`**. ### 💡 Dicas - Você poderá acessar essas credenciais a qualquer momento na seção **"Minhas Aplicações"** do portal. Além dessas credenciais, você também receberá um **usuário e senha para acessar uma conta teste do Conta Azul Pro (ERP)**, permitindo validar suas integrações antes de colocá-las em produção. ## 4. Gerando os tokens de acesso Para consumir qualquer recurso da API, você precisará de: - **`access_token`** (utilizado nas requisições à API) - **`refresh_token`** (utilizado para renovar seu `access_token` após sua expiração) Esses tokens são obtidos através do fluxo OAuth2 usando seu `client_id` e `client_secret`. O processo de autenticação detalhado está disponível na seção [Autenticação da API Conta Azul](/auth). # Boas Práticas de Desenvolvimento Seguro As chaves geradas para a sua integração (`client_id`, `client_secret`, `access_token` e `refresh_token`) possuem poder de acesso e ação em seu nome. **Trate-as como senhas de alto risco.** > ⚠️ **Aviso de Segurança:** Caso identifiquemos qualquer vazamento de credenciais, a aplicação será **excluída imediatamente e sem aviso prévio** como medida de proteção. ## O que NÃO fazer - **Nunca** faça hardcode dessas credenciais — ou seja, nunca as escreva diretamente no código-fonte. - **Nunca** faça commit ou publique essas chaves em repositórios públicos (GitHub, GitLab, Bitbucket, etc.). ## Como proteger suas chaves ### Em ambiente de desenvolvimento local 1. Crie um arquivo `.env` na raiz do projeto e armazene suas credenciais como variáveis de ambiente: ```bash CLIENT_ID=seu_client_id CLIENT_SECRET=seu_client_secret ACCESS_TOKEN=seu_access_token REFRESH_TOKEN=seu_refresh_token ``` 1. Adicione imediatamente a regra `.env` ao arquivo `.gitignore` do projeto para evitar que ele seja versionado: ```bash # .gitignore .env .env.* ``` > **Lembre-se:** a segurança da integração é responsabilidade compartilhada. Proteger suas credenciais garante a integridade dos dados da sua empresa e dos seus clientes. **Próximo passo:** consulte o guia completo sobre o [fluxo OAuth2 e autenticação](/auth) para começar a realizar suas primeiras chamadas à API Conta Azul.