API REST

Bem-vindo à API Pública para Credenciais Digitais da Acreditta! Este guia ajudará você a começar a integrar nossa API em seus aplicativos e sistemas.

A API da Acreditta permite gerenciar e emitir credenciais digitais de maneira integrada. Quer você seja uma instituição educacional, organização ou plataforma, nossa API permite automatizar o processo de credenciamento.

Começando a jornada

1. Obtenha a chave API

Para obter a chave API, você precisa ir até a barra de navegação lateral, puxar para baixo o Integrações menu e clique em API.
Então no API clique na tela Criar APIKey, digite um nome amigável para identificar seu API Key e clique Crie. Você verá então o valor do seu API Key, salve-o bem, pois ele só será exibido uma vez. Quando terminar este processo, você terá um DesenvolvedorUsuário, com nome de usuário API User e senha API Key, você usará esses dois valores para efetuar login na API.

2. Entrar

Você pode fazer login e obter tokens de acesso da seguinte forma (Via Curl):

curl -X 'POST' \
  'https://public-api.acreditta.com/login' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "YOUR_API_USER",
  "password": "YOUR_API_KEY_VALUE"
}'

Lembre-se de substituir “YOUR_API_USER” e “YOUR_API_KEY_VALUE” pelos dois valores do seu Usuário Desenvolvedor criados na etapa anterior. Seguindo o último exemplo, você teria algo assim para acessar a API:

-d '{
  "username": "api_token11760_270",
  "password": "dgT4H5*************************3fH5l"
}'

Na resposta você terá dois valores:

  • idToken: Use isso como Autorização de Token de Portador para todo o uso da API a partir de agora
  • refreshToken: Armazene-o, pois você precisará dele para obter um novo idToken em caso de expiração (usando o endpoint /refresh-token)

3. Consumir API

Agora você pode usar o idToken como Bearer Token como você pode ver no exemplo no cabeçalho Authorization:

curl -X 'POST' \
  'https://public-api.acreditta.com/report/credential/status' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ID_TOKEN'

Se você estiver fazendo o desenvolvimento em nosso ambiente sandbox demo.acreditta.app, você deve ajustar a base da URL da API para https://publicapi-demo.acreditta.app/

Referência de ponto final

Neste link você pode obter a referência completa de todos os Endpoints no swagger
https://public-api.acreditta.com/swagger/#/

Precisa de ajuda?

Se você encontrar algum problema ou tiver dúvidas, entre em contato com nossa equipe de suporte em tech@acreditta.com. Estamos aqui para ajudá-lo em sua jornada com a API de Credenciais Digitais da Acreditta.
Comece a emitir e gerenciar credenciais digitais sem esforço com a poderosa API da Acreditta!

Powered By EazyDocs