Funcionamento

Registe-se no nosso Portal de Desenvolvimento de API

Para poder testar todas as APIs do nosso catálogo de Produtos, pode registar-se de duas formas distintas:

  • Com um certificado digital de tipo QSealC
  • Sem certificado digital

Uma vez recebidas as credenciais, pode aceder ao conjunto de APIs disponíveis, explorar as distintas possibilidades dos planos de utilização definidos para cada API e definir uma aplicação com a configuração de APIs que selecionar.

Registo com certificado digital QSealC

Deve invocar um serviço rest em que uma assinatura eletrónica será solicitada para provar que o TPP possui um certificado de tipo QSealC conforme descrito no regulamento eIDAS (Regulamento UE Nº910 / 2014 do Parlamento Europeu e do Conselho de 23 Julho de 2014).

Este certificado deve ser adquirido através de uma Autoridade de Certificação reconhecida pela European Banking Authority (EBA).

O resultado da chamada de serviço será a entrega de um utilizador e uma senha para o portal privado, a subscrição automática das APIS disponíveis com base na classificação encontrada no certificado e os dados necessários para iniciar automaticamente a chamada da API.

Especificações técnicas

Registo sem certificado digital

Preencha um formulário simples, disponível no menu Registo. Depois de inserir suas as credenciais e do fluxo de aprovação por parte da entidade, tornar-se-á parte da comunidade de desenvolvedores.

Registo

Adicione a sua Aplicação

Uma vez registado, adicionar e configurar as suas aplicações. Cada aplicação permitirá que, com as suas credenciais correspondentes (Chave de API), faça seu código funcionar rapidamente com todos os serviços da API de que necessita.

Aceda ao "Painel de Controlo" das suas aplicações e clique em "Adicionar aplicativo" para criar a sua primeira aplicação. No início, terá acesso para testar todas as APIs desejadas no ambiente de testes (Sandbox). Para o ambiente de produção, deve solicitar acesso e forneceremos credenciais alternativas.

Deve identificar a sua aplicação exclusivamente por meio do nome e do identificador (ID) da mesma. O nome da aplicação é o que seus clientes verão quando a usarem.

De todas as APIs disponíveis, ative as que forem necessárias para fazer seus desenvolvimentos no ambiente de teste (Sandbox).

Por fim, clique no botão "Adicionar aplicação" e, nesse momento, criará automaticamente um "OAuth secreto", que será necessário para autenticar a sua aplicação e obter o token de acesso para fazer chamadas para as APIs selecionadas. Poderá consultar todos esses dados, mais tarde, nos detalhes das suas aplicações "Painel de controlo".

E já está concluído. A partir deste momento pode conectar-se às nossas APIs!