Quickstart guide

Este guia foi criado para apoiar o início da utilização dos recursos da Certiface API.
Encontre instruções claras e objetivas para iniciar a integração e realizar as primeiras chamadas de forma fácil, dinâmica e intuitiva.

Vamos começar!

1. Primeiros passos

• Saiba sobre nossa plataforma de identificação e autenticação: Certiface API;
• Conheça nossas ferramentas e compreenda as funcionalidades de cada uma delas. Ter esse entendimento enriquece as operações e facilita sua jornada de integração;
• Os componentes para integração estão documentados nesta página, conheça-os;
• Entenda padrões e tecnologias, parâmetros, respostas e autenticação para uso da Certiface API.

2. Antes de testar, autentique-se!

Primeiro método: Token.
Para iniciar as operações de testes neste DevCenter, você deve ter em mãos as credenciais de autenticação: username e password.

💡

Lembre-se!

O acesso aos dados de crendenciais deve ser disponibilizado pela Oiti.
Caso ainda não possua credenciais, contate-nos agora.

Esses campos devem ser preenchidos no primeiro endpoint a ser testado: Token; e devem ser preenchidos na terceira coluna da página, na seção AUTHENTICATION, nos campos apresentados abaixo.
Por fim, clique no botão Try it.

3. Para começar os primeiros testes

Entenda nesta seção como operar testes rápidos e os retornos das requisições solicitadas.

3.1 Saiba como testar

Para realizar os primeiros testes, utilize este DevCenter como sua plataforma principal.
A partir da página de cada endpoint, você poderá enviar as requisições e visualizar as respostas de forma imediata.
Para isso, utilize o botão "Try it", localizado na terceira coluna de cada página.
Essa funcionalidade permitirá que você execute as chamadas de teste de maneira prática e rápida, facilitando a interação e a compreensão dos resultados obtidos.

3.2 Sobre o Response

Após enviar as suas requisições, o resultado do Request será exibido na seção Response.
Nessa seção, você terá acesso às informações de resposta da API, como o status, os cabeçalhos e o corpo da resposta. É fundamental verificar atentamente essa seção para compreender os detalhes e os dados retornados pela API em relação à sua requisição.

❗️

Deu ruim! O teste não foi executado com sucesso?

Consulte a lista de erros configurada para as operações da Certiface API, acesse a seção Apoio > Lista de Erros. Nessa lista, encontre detalhes dos códigos de erro que podem ser retornados pela API, com suas descrições e possíveis soluções.

4. Sobre os headers

A presença e o conteúdo específico dos headers podem variar dependendo das necessidades da aplicação.
Para os testes da jornada, como: criar ticket; gerar appkey; processar e consultar resultado da transação, devem ser informados:

💡

Como obter informações de headers?

Esses dados serão disponibilizados à empresa contratante logo após a conclusão do processo de configuração (setup) realizado em parceria com o time técnico da Oiti.

Os dados compõem uma estrutura orientada às regras de negócio da empresa; uma espécie de hierarquia entre as unidades, departamentos, operações etc.