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"
}

Atualizar credencial#

Endpoint: PUT /api/organizations/:cnpj/credentials/:uuid

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 /api/organizations/:cnpj/credentials

Exemplo de retorno:

[
    {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "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 e deleted. Por padrão a listagem de credenciais lista apenas as credenciais active, mas é possível mudar este comportamento adicionando o parâmetro status desta forma: GET /api/organizations/:cnpj/credentials?status=status

Detalhes da credencial#

Endpoint: GET /api/organizations/:cnpj/credentials/:uuid

Exemplo de retorno:

{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "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 /api/organizations/:cnpj/credentials/:uuid

Como utilizar a credencial em uma consulta#

As fontes de consulta que exigem credencial recebem a credencial no campo credential, no corpo (JSON) da requisição. O valor deve ser o UUID da credencial cadastrada. Exemplo:

{
  "credential": "550e8400-e29b-41d4-a716-446655440000",
  "cpfCnpj": "99999999999"
}