Pottencial APIs

Este recurso oferece a utilização dos produtos e serviços oferecidos pela Pottencial, podendo se integrar em qualquer plataforma ou dispositivo via comunicação por APIS.

Acesso as Aplicações - APIS

Para acessar as aplicações em Developer, deverá acessar minha conta para criar uma nova conta ou efetuar o login caso já tenha conta cadastrada.

No primeiro acesso deve-se realizar o cadastro, e após realização deste efetuar o login passando e-mail de cadastrado e sua senha.

Na barra de opções do site em Dev Tools selecionar Dev Tools > Minhas Apps. , para criar um app.
O App
lhe garantirá o acesso as aplicações da Pottencial, podendo utilizar a Jornada de contratação ou pos venda.

Informando um nome e descrição para seu app , associe as APIS que utilizará para se integrar com a Pottencial, (não esquecer da API OAuth para obter o token de acesso) . No final escolha a opção registrar assim obterá Client ID / Client Secret para utilizar o ambiente Sandbox.

Na documentação , baixar a Collection do postman com os exemplos com o seu Client ID e Secret da sua conta.
Deverá utilizar na API OAuth para obter o token de acesso, com o token e seu Client ID poderá executar as requisições e simular a utilização das APIS disponíveis pela Pottencial.

Ambiente

Observação as credenciais de Homologação e Produção solicitar com o comercial Pottencial, será enviado as novas credenciais do ambiente solicitado)

Sandbox :

Ambiente para simular requisições, onde poderá efetuar os enviar e obter os retornos (request, response)
url: https://api-sandbox.pottencial.com.br

Homologação :

Ambiente utilizado para interagir e validar as regras e validação de cada produto fornecido pela Pottencial
url: https://api-hml.pottencial.com.br

Produção :

Cliente homologado, com os testes efetuados em Homologação e todos os processos ( judicial, contratual e afins)
url: https://api.pottencial.com.br

Autenticação

A API de autenticação é o primeiro passo para ter acesso às demais APIs da Pottencial.

Através dela é possível, a partir de um client_id e client_secret, obter um access_token que será utilizado nas demais APIs.

Criar um APP

No portal do desenvolvedor, após realizar o cadastro, você poderá cadastrar a sua APP acessando o menu Dev Tools > Minhas Apps.

Ao cadastrar o APP, serão gerados um client_id e client_secret para ele.

IMPORTANTE: O client_id e client_secret são suas chaves de acesso e não devem ser compartilhados.

Gerar um Access Token

Para acessar as outras APIs na Pottencial, é necessário gerar um access_token a partir da operação /oauth/v3/access-token, conforme detalhes abaixo:

Request

Url	https://api-sandbox.pottencial.com.br/oauth/v3/access-token
Method	POST
Authorization	Basic Auth	A chave de autenticação deve ser gerada a partir do client_id e do client_secret. Na requisição HTTP, deve ser adicionado um header Authorization com o valor Basic , onde credentials é o client_id e o client_secret unidos por dois-pontos, codificado em Base64 (UTF-8). No Postman, basta selecionar na guia Authorization a opção Basic Auth e preencher os campos Username e Password com os valores do client_id e do client_secret, respectivamente.
Body	Vazio

Response

O resultado da chamada será um JSON contendo o access_token necessário para o consumo das demais APIs.

access_token	Contém o token de acesso que será utilizado para autenticar nas demais APIs.
refresh_token	Contém o token para atualização do token de acesso, quando esse último expirar.
token_type	Tipo do token de acesso "access_token".
expires_in	Tempo em segundos que o access_token vai expirar.

Exemplo:

    
    {
        "access_token": "57f10f0e-3d2e-311f-a797-4011f66e1cbf",
        "refresh_token": "ca81cb16-43e4-3e96-aaea-4861e7791dc7",
        "token_type": "access_token",
        "expires_in": 3600
    }