Skip to main content

​
O que é

Esta página explica em quais ambientes você pode usar a API, como ficar sabendo de mudanças que afetam a sua integração e como pedir ajuda ao time do Symphony.

​
Ambientes

​
Testando a sua integração

Não existe um ambiente de testes aberto (sandbox). Na maioria dos casos, você pode desenvolver direto em produção, com alguns cuidados:
  • Peça uma conta técnica dedicada ao administrador da sua empresa. Assim o consumo dos testes fica separado do seu uso pessoal, e o administrador pode definir um limite de consumo baixo para essa conta.
  • Use modelos mais baratos enquanto desenvolve e troque pelo modelo definitivo só no final.
  • Limite o volume. Teste lotes com poucos itens antes de rodar o processamento completo.
  • Acompanhe o consumo com GET /api/v1/consumption/me.

​
Quando pedir acesso à homologação

Peça acesso ao HML quando você precisar:
  • testar uma integração que pode gerar volume ou custo alto antes de liberar em produção;
  • validar a sua integração contra uma versão do Symphony que ainda não chegou em produção.
O HML tem uma cópia de parte do que existe em produção, mas não de tudo. Antes de testar, confira se a sua chave de API, o seu X-Enterprise-Id e os modelos e agentes que você vai usar existem no HML.

​
Como solicitar acesso ao HML

O acesso ao HML é liberado sob pedido e apenas para colaboradores da FCamara. Para solicitar, entre em contato com o time do Symphony pelo WhatsApp ou por e-mail symphony@fcamara.com.

​
Mudanças na API

​
Versão do Symphony

Para saber qual versão está rodando em um ambiente:
As novidades de cada versão são publicadas em Releases.

​
O que é estável

A API não tem números de versão próprios. O v1 que aparece em alguns caminhos (/api/v1/...) faz parte do endereço e não muda a cada versão do Symphony. Para a sua integração continuar funcionando ao longo do tempo:
  • Use só os endpoints da Referência da API. Endpoints fora dela são internos e podem mudar sem aviso.
  • Ignore campos que você não conhece nas respostas. Campos novos podem ser adicionados a qualquer momento, e isso não é considerado uma mudança que quebra.
  • Trate erros pelo code, nunca pelo texto da mensagem (veja Erros e limites).
  • Não fixe IDs de modelo no código. Leia o modelo de uma configuração e valide com GET /api/models na inicialização. O catálogo é gerenciado pela sua empresa e pode mudar.

​
Suporte

​
Antes de abrir um chamado

1

Confira o início rápido

Veja Problemas mais comuns no começo em Conectar via API. A maioria dos problemas iniciais é chave ou X-Enterprise-Id.
2

Procure o code do erro

Consulte o catálogo de códigos em Erros e limites.
3

Confirme permissões e limite

Confira com o administrador da sua empresa se a sua conta tem a permissão e o limite de consumo necessários.

​
Quem procurar

Fale com o time do Symphony pelo WhatsApp ou por e-mail symphony@fcamara.com.

​
O que enviar no chamado

  • O request_id da resposta de erro.
  • O ambiente (produção ou HML).
  • O endpoint, o horário aproximado e o fuso horário.
  • O status HTTP e o code do erro.
  • O corpo da requisição, sem a chave de API.
Nunca envie a sua chave de API, nem em chamado, nem em e-mail, nem em print. Se ela vazar, gere uma nova na hora em Configurações → Conta → Chaves de API.

​
Documentos relacionados