API: criando uma chave e fazendo a primeira chamada
Gere uma chave de acesso, escolha o que ela pode fazer e teste a conexão para integrar sua loja virtual, marketplace ou outro sistema.
3 min de leitura · Avançado · atualizado em 06/10/2026
A API do SG Fênix deixa outro sistema (a sua loja virtual, um marketplace, uma planilha automática, um painel de BI) ler e enviar dados sem ninguém digitar. Quem acessa usa uma chave, criada por você em Configurações › Integrações › APIs.
Como a chave funciona
- A chave age numa empresa e como o usuário que a criou: ela nunca pode mais do que esse usuário pode. Se o usuário perder o acesso ou for desativado, a chave para de funcionar.
- Além disso, você marca quais recursos a chave enxerga e se ela só lê ou também envia (Enviar inclui ler).
- As regras de sempre continuam valendo: isolamento entre organizações, permissões por ação e módulos liberados.
O token (um texto começando com sgf_) aparece uma única vez, logo depois de criar a chave. O sistema guarda só uma "impressão digital" dele, então não há como recuperá-lo depois. Se perder, crie outra chave e revogue a antiga.
1Criar a chave
Em Nova chave, escreva um nome que diga para que ela serve (ex.: "Loja virtual"), escolha a Empresa, a Validade (sem prazo, 30 dias, 90 dias ou 1 ano) e marque as permissões. Clique em Criar chave. ::
2Copiar o token
A caixa verde mostra o token. Copie e guarde num cofre de senhas ou nas configurações seguras do seu outro sistema. Só então clique em Já copiei. ::
3Testar a conexão
Peça ao responsável técnico para chamar o endereço de teste. Se a resposta trouxer o nome da sua empresa, está tudo certo:
curl https://SEU-ENDERECO/api/v1/eu -H "Authorization: Bearer SUA_CHAVE"
::
O que dá para acessar
| Recurso | Ler | Enviar |
|---|---|---|
| Clientes | sim | criar e atualizar contato |
| Fornecedores | sim | não |
| Produtos (com preços) | sim | não |
| Saldos de estoque | sim | não |
| Pedidos de venda | sim | criar (como rascunho) |
| Títulos a receber e a pagar | sim | não |
| Notas fiscais (NF-e e XML) | sim | não |
Boas práticas de segurança
- Crie uma chave por integração, com o mínimo de permissões. Assim dá para revogar só a que vazou.
- Use Validade em chaves temporárias (testes, consultorias).
- Em Pausar a chave deixa de valer na hora e pode ser Reativada; em Revogar o acesso termina de vez.
- A lista mostra último uso, IP e chamadas de cada chave: estranhou um acesso? Revogue.
- Existe um limite de chamadas por minuto por chave. Passou do limite, a API responde que deve aguardar um minuto.
Quer ser avisado em tempo real, sem ficar perguntando ao sistema toda hora? Use os webhooks: veja o guia "Webhooks: receba os eventos do sistema".
Quer avaliar este guia ou usar o sistema? Entre ou cadastre-se.