Melhores práticas

APIs da DigiCert oferecem aos desenvolvedores muita liberdade e personalização. Assim, é importante entender como aproveitar ao máximo a sua integração de API. Ao seguir essas melhores práticas, você reduzirá o seu número total de chamadas de API e assegurará receber os tempos de respostas mais rápidos.

Chaves de API

Usar a chave correta

Para gerar uma chave API, é necessário vinculá-la a um usuário existente. Isso fornece autenticação e autorização para a chave de API. Ao construir integrações de API, certifique-se de usar uma chave de API com as permissões necessárias para completar as tarefas requeridas.

Solicitações

Evitar solicitações paralelas

Recomendamos que você não envie solicitações paralelas, pois isso pode aumentar os tempos de resposta e pode causar comportamento inesperado. Solicitações paralelas também aumentam o risco de atingir o seu limite de taxa de solicitação, temporariamente bloqueando o seu acesso de API.

Enviar múltiplas solicitações sequencialmente

Ao trabalhar com múltiplas solicitações, envie solicitações sequencialmente (uma por vez) e sempre aguarde um código de resposta antes de enviar a próxima solicitação na fila. Isso produz o melhor desempenho de transmissão de dados e amplamente reduz a chance de comportamentos anormais e erros.

Pedidos

Sempre incluir o parâmetro skip_approval

Por padrão, solicitações de pedidos de certificados SSL/TLS incluem uma etapa de aprovação que deve ser concluída antes que a DigiCert possa processar o pedido.

Você pode pular esta etapa de aprovação ao incluir o parâmetro skip_approval com um valor de true no corpo da solicitação dos seus pedidos. Isso agiliza os tempos de resposta consideravelmente e lhe permite tirar vantagem da emissão imediata de certificado.

Usar o ponto de extremidade de alteração de status para status do pedido

Após enviar um pedido, você desejará saber quando status do pedido mudar o certificado estiver pronto para download. Em vez de fazer múltiplas chamadas para verificar o status de cada pedido, use o ponto de extremidade Lista de alteração de status.

O ponto de extremidade da lista de alteração de status retorna uma lista de pedidos que mudou o status em um período específico (até 7 dias no passado). Quando o status de um pedido muda de pendente para emitido, é possível usar a order_id retornada para obter detalhes específicos do pedido ou para baixar o certificado.

Obter ambas versões de um domínio gratuitamente

Ao solicitar, reemitir e duplicar certificados de domínios exclusivos, é possível escolher se deve incluir uma SAN adicional específica gratuitamente.

Para proteger ambas as versões do seu domínio ([your-domain].com e www.[your-domain].com), na sua solicitação, use o parâmetro common_name para adicionar o domínio ([your-domain].com) e a matriz dns_names[] para adicionar a outra versão do domínio (www.[your-domain].com). Se você deseja proteger apenas o nome comum (FQDN), simplesmente omita o parâmetro dns_names[] da sua solicitação.

Para o ponto de extremidade Order SSL (type_hint), é necessário adicionar o domínio base (diferente da versão www) ao parâmetro common_name e a SAN adicional (versão www) à matriz dns_names.

Example request body
{
    "certificate": {
        "common_name": "example.com",
        "dns_names": [
            "www.example.com"
        ],
    ...