Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

https://api.plexi.com.br/

Informações essenciais

O CNPJ passado no endpoint /api/organizations/:cnpj/certificates refere-se ao CNPJ do cliente PLEXI, que está solicitando a operação. É importante garantir que o CNPJ informado corresponda ao cliente autorizado, pois ele será utilizado para validações internas de segurança e permissão.

Cadastrar certificados

Endpoint: POST /api/organizations/:cnpj/certificates

...

Code Block
languagejson
{
    "name": "certificado-1",
    "metadata": "Qualquer informação extra que possa ajudar na identificação do certificado",
    "certificate": {
        "pfx": "base64 encoded",
        "password": "123"
     }
}

Também é possível enviar diretamente o conteúdo do certificado junto com sua chave privada (com ou sem senha), já descriptografada, ambos codificados em base64

Code Block
languagejson
{
    "name": "certificado-1",
    "certificatemetadata": {"Qualquer informação extra que possa ajudar na identificação do "certcertificado",
    "certificate": "base64{
encoded",         "keycert": "base64 encoded",
        "passwordkey": "123base64 encoded"
     }
}
Info

O campo name será o identificador do certificado, é este valor que será utilizado para utilização e gerenciamento do certificado após sua criação.

...

Code Block
languagejson
{
    "certificatemetadata": {
    "Qualquer informação extra que possa ajudar na identificação do certificado",
    "certcertificate": "base64 encoded",{
        "keycert": "base64 encoded",
        "passwordkey": "123base64 encoded"
     }
}

ou

Code Block
languagejson
{
    "metadata": "Qualquer informação extra que possa ajudar na identificação do certificado",
    "certificate": {
        "pfx": "base64 encoded",
        "password": "123"
    }
}

...

Code Block
languagejson
[
    {
        "name": "certificado-cliente-1",
        "metadata": "Qualquer informação extra que possa ajudar na identificação do certificado",
        "certificate" : {
           "common_name": "FULANO DE TAL 1234567890",
           "fingerprint": "VXRpbC9IdG1sSnNvbkZpbmRlci5waHAK",
           "due_date": "2024-01-01T00:00:00Z"
        }
     },
    {
        "name": "certificado-cliente-1",
        "metadata": "Qualquer informação extra que possa ajudar na identificação do certificado",
        "certificate" : {
           "common_name": "FULANO DE TAL 1234567890",
           "fingerprint": "VXRpbC9IdG1sSnNvbkZpbmRlci5waHAK",
           "due_date": "2024-01-01T00:00:00Z"
        }
     },
]     

...

Code Block
languagejson
{
  "name": "certificado-cliente-1",
  "metadata": "Qualquer informação extra que possa ajudar na identificação do certificado",
  "certificate" : {
    "common_name": "FULANO DE TAL 1234567890",
    "fingerprint": "VXRpbC9IdG1sSnNvbkZpbmRlci5waHAK",
    "due_date": "2024-01-01T00:00:00Z"
  }
}

...