Rap-conector-client NPM

Instalação

npm install rap-conector-client

Utilização

CommonJS

const ConectorClient = require('rap-conector-client');

const Conector = ConectorClient.Create({
  url: 'myUrl',
  client_id: 'aaaa-bbbb-cccc',
  debug: true
});

Conector.healthCheck()
  .then(console.log)
  .catch((error)=>console.log(error));

ES6

import { Create as ConectorClient } from 'rap-conector-client';

const Conector = ConectorClient({
  url: 'myUrl',
  client_id: 'aaaa-bbbb-cccc',
  debug: true
});

Conector.healthCheck()
  .then(console.log)
  .catch((error)=>console.log(error));

Tipos

É possível importar os tipos através do objecto TYPES

import { Create as ConectorClient, TYPES } from 'rap-conector-client';

console.log(TYPES.DocumentTypes) // GroupTypes, RevokeReason, etc.

Conector externo

CommonJS

const ConectorClient = require('rap-conector-client');

const Conector = ConectorClient.CreateExternal({
  url: 'myUrl',
  client_id: 'aaaa-bbbb-cccc',
  debug: true
});

Conector.healthCheck()
  .then(console.log)
  .catch((error)=>console.log(error));

ES6

import { CreateExternal as ConectorClient } from 'rap-conector-client';

const Conector = ConectorClient({
  url: 'myUrl',
  client_id: 'aaaa-bbbb-cccc',
  debug: true
});

Conector.healthCheck()
  .then(console.log)
  .catch((error)=>console.log(error));

Exemplos

Autenticação

Utilizando promises

const ConectorClient = require('rap-conector-client');

const Conector = ConectorClient.Create({
  url: 'http://localhost:8040',
  client_id: 'aaa-bbb-ccc-ddd',
});


Conector.auth({ 
  email: 'example@test.com',
  password: '123456'
}).then((userData) => {
    console.log(userData); //accessToken, name...

    Conector.getDocument({
      docId: 5
    })
      .then(console.log)
      .catch((error) => console.log(error));

})
  .catch((error) => console.log(error));

Utilizando async/await

const ConectorClient = require('rap-conector-client');

const Conector = ConectorClient.Create({
  url: 'http://localhost:8040',
  client_id: 'aaa-bbb-ccc-ddd',
});

async function myAsyncFunction(){
  try{
    // Se não deseja receber os dados de usuário basta retirar o const userData:
    // Exemplo: await Conector.auth({email: "", password: ""})
    
    const userData = await Conector.auth({ 
      email: 'example@test.com',
      password: '123456'
    })
    console.log(userData);

    const document = await Conector.getDocument({
      docId: 5
    });
    console.log(document);
  }catch(error){
    console.log(error);
  }
}

myAsyncFunction();

Estados de retry

processCode	Rota	Descrição
500	restart-processing	Reinicia o processamento de um documento que ainda não esteja no estado de registro válido ou que esteja em um estado de erro.
501	restart-generation	Tenta reexecutar o processo de geração do documento que ainda não esteja registrado ou em um estado de erro.
502	restart-signature	Tenta reexecutar o processo de assinatura do documento que ainda não esteja registrado ou em um estado de erro.
503	restart-signature	Tenta reexecutar o processo de assinatura do documento que ainda não esteja registrado ou em um estado de erro.
504	restart-registration	Tenta reexecutar o processo de registro de um documento assinado que ainda não esteja registrado ou em um estado de erro.
505	restart-registration	Tenta reexecutar o processo de registro de um documento assinado que ainda não esteja registrado ou em um estado de erro.
506	restart-revocation	Tenta reexecutar o processo de revogação de um documento assinado que ainda não esteja registrado ou em um estado de erro.

Tratamento de erro

Utilizando promises

Conector
  .getDocuments(options)
  .then(console.log)
  .catch((error)=>console.log(error));

Utilizando async/await

try{
  const documents = await Conector.getDocuments();
  //do something
}catch(error){
  console.log(error);
}

Retorno

{error: true, message: "error message", code: "integer"}

Códigos de erro

Código	Descrição
400	Credenciais de autenticação inválidas
401	Credenciais de autenticação inválidas
404	Objeto não encontrado no conector
422	Não foi possível processar os dados da requisição
500	Ocorreu um erro inesperado no servidor
501	Erro na validação interna da client, por exemplo: docId não informado