Credenciais

Algumas fontes de consulta do Plexi requerem a utilização de credenciais pessoais que precisam ser cadastradas.

URL Base:

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

Informações essenciais

O CNPJ passado no endpoint /api/organizations/:cnpj/credentials 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 credenciais

Endpoint: POST /api/organizations/:cnpj/credentials

É possível cadastrar uma credencial enviando usuário e senha

{
    "name": "credencial-joao",
    "user": "joao@empresa.com",
    "password": "senha"
}

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

Atualizar credencial

Endpoint: PUT /organizations/:cnpj/credentials/:name

Para atualizar uma credencial basta enviar seus dados como no endpoint de criação, sem o campo name no corpo.

{
    "user": "joao@empresa.com",
    "password": "senha"
}

Listar credenciais

Endpoint: GET /organizations/:cnpj/credentials

Exemplo de retorno:

[
    {
        "name": "credencial-joao",
        "user": "joao@empresa.com",
        "status": "active",
        "created_at": "2025-05-27 19:09:30",
        "updated_at": "2025-05-27 19:09:30"
    }
]

As credenciais no Plexi tem 2 status: active, deleted Por padrão a listagem de credenciais lista apenas as credenciais active, mas é possível mudar este comportamento adicionando o parâmetro statusdesta forma: GET /organizations/:cnpj/credentials?status=status

Detalhes da credencial

Endpoint: GET /organizations/:cnpj/credentials/:name

Exemplo de retorno:

{
    "name": "credencial-joao",
    "user": "joao@empresa.com",
    "status": "active",
    "created_at": "2025-05-27 19:09:30",
    "updated_at": "2025-05-27 19:09:30"
}

Deletar credencial

Endpoint: DELETE /organizations/:cnpj/credentials/:name