A API Local está sendo descontinuada. Consulte o documento Descontinuação da API Local para ver mais informações e saber como migrar para nossa API de Nuvem de última geração.

Externos

/v1/certificates/external

Use esta borda para carregar, recuperar, excluir e redefinir seus certificados da autoridade de certificação (CA, pelas iniciais em inglês).

Antes de começar

É preciso usar uma conta de admin para carregar e excluir todos os certificados.

Recuperação

Faça chamadas GET ao ponto de extremidade para recuperar o certificado CA armazenado no cliente da WhatsApp Business API.

Exemplo

Solicitação:

GET /v1/certificates/external/ca

Resposta:

Content-Type: text/plain
Content-Length: content-size

certificate

Se nenhum certificado de CA for encontrado, um código de resposta 404 será retornado sem corpo.

Como carregar

Faça chamadas POST para carregar um certificado de CA. Verifique se o certificado carregado contém as seguintes seções em um arquivo nesta mesma ordem:

  1. Chave privada
  2. Certificado
  3. Um ou mais certificados intermediários de CA: o cliente da WhatsApp Business API requer no mínimo um certificado intermediário de CA para que não haja falha no carregamento.

Exemplo

Para carregar o certificado do cliente da WhatsApp Business API, use a seguinte solicitação de API, que contém o Content-Type de text/plain.

POST /v1/certificates/external
  Content-Type: text/plain
  Content-Length: content-size

certificate

Se estiver usando um cURL, o comando terá esta aparência:

curl -X POST \
  https://your-webapp-hostname:your-webapp-port/v1/certificates/external \
  -H 'Authorization: Bearer your-auth-token' \
  -H 'Content-Type: text/plain' \
  --data-binary @your-path-to-certificate.pem 

Se um certificado já existir, ele será substituído. Você deverá reiniciar o servidor da web, ou seja, as instâncias do contêiner do Webapp, depois que o certificado for carregado.

Tenha muito cuidado para atualizar somente o certificado que tiver um certificado válido (ou seja, adequado e correto). Caso contrário, ocorrerá uma falha ao reiniciar o servidor da web (já que o ponto de extremidade da API não funcionará). Nesse caso, você precisará intervir manualmente para resolver a situação.

A resposta à sua chamada de API terá esta aparência:

null

Como redefinir

Caso você carregue um certificado de CA inválido para o cliente da WhatsApp Business API, a reinicialização dos contêineres de Webapp falhará, pois o ponto de extremidade da API estará desativado. Para resolver a situação, é preciso remover a tabela de banco de dados certs.

Para remover a tabela de banco de dados certs:

  1. Pare o contêiner do Webapp:
    docker stop your-webapp-container-id
  2. Conecte-se ao MySQL via Docker na linha de comando:
    docker exec -it your-mysql-container-id mysql -uroot -p
  3. Digite a senha do MySQL quando solicitado (conforme mysql.conf).
  4. Verifique se a tabela certs existe:
    show tables in waweb;
  5. Remova a tabela certs:
    drop table waweb.certs;
  6. Saia do MySQL:
    exit;
  7. Reinicie o contêiner do Webapp:
    docker restart your-webapp-container-id
  8. Entre novamente no MySQL usando as etapas acima para verificar se agora a tabela certs existe.

Exclusão

Não há suporte para a exclusão de certificados. Poderemos oferecer suporte para isso no futuro se houver um caso de uso que não cobrimos.