Primeiros Passos

Tudo que você precisa para fazer a primeira chamada à API.

1. Solicitar acesso#

Entre em contato com a Multiplus Card para habilitar seu acesso. Nossa equipe configura o ambiente de testes e libera os portais PINPDV (representante e cliente).

• WhatsApp / Telefone: 0800-777-8134
• E-mail: comercial@multipluscard.com.br

2. Gerar seu token#

Com o acesso liberado, entre no Portal do Cliente PINPDV e gere seu token de integração, em Configurações → Configurações de Conta → Tokens de acesso → Cadastrar. Clique nas imagens para abri-las em tamanho real.

1. Abra o menu do usuário. No canto superior direito do portal, clique sobre o nome do usuário logado.

2. Selecione “Configurações”. No menu que se abre, clique em Configurações.

3. Abra “Tokens de acesso”. No menu lateral, dentro de Configurações de Conta, clique em Tokens de acesso.

4. Clique em “Cadastrar”. Informe a descrição e a data de expiração do token. A lista mostra, para cada token, a descrição, a data de expiração, o status e a data de revogação.

O token gerado é de longa duração — expira somente na data cadastrada. Armazene-o de forma segura; ele será usado em todas as requisições.

3. Fazer a primeira chamada#

Com o token em mãos, você já pode chamar a API. Teste listando os dispositivos disponíveis:

curl --request GET \
  --url 'https://api.pinpdv.com.br/pinpdv' \
  --header 'Authorization: Bearer {SEU_TOKEN}'

Uma resposta 200 OK com a lista de dispositivos confirma que sua integração está funcionando.

URL base#

https://api.pinpdv.com.br

Autenticação#

Todas as requisições devem incluir o header:

Authorization: Bearer {token}

Formato de resposta#

• Respostas em JSON
• 2xx — sucesso
• 4xx — erro na requisição (verifique os parâmetros enviados)

Para a referência dos códigos de status HTTP, consulte a documentação de referência HTTP da MDN.

Rate limit#

Convenção de campos variáveis#

Campos no formato {CHAVE} nos exemplos devem ser substituídos pelo valor real no seu contexto.

Exemplo: {SEU_TOKEN} → o token gerado no portal.

Consultando seus dispositivos#

Você pode obter o ID e código dos seus Smart POS de duas formas:

• Portal do Cliente PINPDV — acesse a lista de dispositivos diretamente pelo portal
• API — consulte via endpoint:

curl --request GET \
  --url 'https://api.pinpdv.com.br/pinpdv' \
  --header 'Authorization: Bearer {SEU_TOKEN}'

200 - OK

{
  "paginaAtual": 1,
  "itensPorPagina": 100,
  "quantidadeTotalDeItens": 2,
  "data": [
    {
      "id": 1,
      "codigo": "526989",
      "nome": "CAIXA 01",
      "versao": "1.0.1.5",
      "app": 1,
      "grupos": [ { "identificador": "grupo-padrao", "nome": "Padrão" } ],
      "isAtivo": true,
      "heartbeat": "2024-10-04T15:49:28.894765"
    },
    {
      "id": 2,
      "codigo": "687836",
      "nome": "CAIXA 02",
      "isAtivo": true,
      "heartbeat": "2024-10-01T15:04:15.204673"
    }
  ]
}

Use o id do dispositivo como PinPdvId nas requisições dos módulos TEF Mobile e Pré-venda.

O Smart POS tem seu heartbeat atualizado sempre que entra no fluxo TEF Mobile ou na página inicial do app PINPDV.

Consultando suas empresas#

Útil para confirmar se o token pertence à empresa que você deseja integrar.

curl --request GET \
  --url 'https://api.pinpdv.com.br/empresa?OrdenarPor=Id&OrdenarTipo=DESC' \
  --header 'Authorization: Bearer {SEU_TOKEN}'

200 - OK

{
  "paginaAtual": 1,
  "itensPorPagina": 100,
  "quantidadeTotalDeItens": 1,
  "data": [
    {
      "id": 1,
      "nome": "Empresa Exemplo",
      "razaoSocial": "Empresa Exemplo Ltda",
      "cnpj": "12.345.678/0001-90",
      "situacao": { "isAtivo": true, "vigenciaAte": null },
      "representante": {
        "id": 10,
        "nome": "Representante Exemplo",
        "usuario": "12345678000190",
        "urlPortal": "venda"
      }
    }
  ]
}