Endpoints da API

Catálogo de rotas disponíveis na API pública da Acreditta, agrupadas pelo que você precisa fazer. Todas exigem o header Authorization: Bearer <idToken> que você obtém em Primeiros passos com a API, exceto quando indicado o contrário.

🔎 Observação: esta tabela resume o propósito de cada rota. Os parâmetros exatos, o corpo da requisição e os códigos de resposta completos estão no Swagger: https://public-api.acreditta.com/swagger/#/.

Emitir credenciais

Rota Método Uso
/credential/issue POST Emite uma credencial individual.
/credential/batch/create POST Cria um lote de emissão.
/credential/batch/close/{batchId} PATCH Fecha um lote de emissão já criado.

Emitir uma credencial individual

POST /credential/issue recebe os seguintes campos no corpo:

Campo Tipo Obrigatório Notas
credentialTemplateId string Sim ID do modelo de credencial a emitir.
firstName string Sim Primeiro nome do acreditado.
lastName string Não Sobrenome do acreditado.
email string (email) Sim E-mail do acreditado — recebe a notificação se sendNotification for true.
phoneNumber string Não Com código do país, ex. +573203133677.
identification string Não Número de identificação do acreditado.
awardedAt string (data) Sim Data de concessão da credencial.
expiresAt string (data) Não Data de expiração, se a credencial tiver.
creditHours integer Não Horas de crédito associadas, se o modelo as usar.
licenseNumber string Não Número de licença, se o modelo exigir.
result string Não Resultado ou nota obtida.
programStartDate / programEndDate string (data) Não Datas de início e fim do programa cursado.
degreeCertificate string Não Número ou identificador do certificado/diploma.
book / sheet string Não Livro e folha de registro, se sua instituição usar.
evidences array (máx. 5 itens) Não Evidências da conquista. Cada item aceita name (obrigatório), description e url.
evidenceAnnexe object Não Anexo adicional: annexe (conteúdo) e type (markdown ou url).
issuingTags array de string Não Tags livres para classificar a emissão.
sendNotification boolean Não Se o acreditado deve ser notificado por e-mail assim que a credencial for emitida.
overwriteRecord object Não Sobrescreve, somente para esta emissão, o design (recordDesign), os textos (texts) ou as imagens (images) do registro. Veja Personalizar o registro com overwriteRecord.
updateCredential boolean Não true para atualizar uma credencial já emitida em vez de criar uma nova. Padrão false.
credentialUUID string Não Obrigatório somente quando updateCredential for true — identifica a credencial a atualizar.

Além disso, POST /credential/issue aceita o parâmetro de consulta batch_id (integer, opcional): se você o enviar, a credencial é adicionada ao lote de emissão indicado em vez de ser emitida avulsa (veja Emissão de credenciais em lote).

A resposta inclui credentialId, transactionBlock, acceptanceLink e rejectionLink.

{
  "credentialTemplateId": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "user@example.com",
  "awardedAt": "2026-09-07",
  "evidences": [
    { "name": "string", "description": "string", "url": "string" }
  ],
  "sendNotification": true
}

🔎 Observação: para atualizar uma credencial já emitida em vez de criar uma nova, envie updateCredential: true junto com credentialUUID.

Emissão de credenciais em lote

Para emitir para muitos acreditados: crie o lote com POST /credential/batch/create (informando credentialTemplateId), emita as credenciais individuais dentro desse lote passando o batch_id como parâmetro de consulta em POST /credential/issue, e ao terminar, feche-o com PATCH /credential/batch/close/{batchId}.

Consultar credenciais

Rota Método Uso
/credential/list GET Lista as credenciais da sua organização.
/credential/{credentialId} GET Consulta uma credencial específica.
/credential/record/{credentialId} GET Obtém o registro/comprovante de uma credencial.
/report/credential/status GET Relatório de status das credenciais.

🔎 Observação: /credential/record/{credentialId} é a única rota de credenciais que não exige um plano com a API habilitada — ela permanece aberta para não quebrar integrações antigas de PDF/comprovantes. As demais exigem o recurso de API ativo no seu plano (veja Planos e limites).

Gerenciar credenciais

Rota Método Uso
/credential/revoke/{credentialId} PATCH Revoga uma credencial.

Modelos e fluxos

Rota Método Uso
/template/list GET Lista os modelos da sua organização.
/template/validate-user GET Verifica se um e-mail tem acesso a um modelo (parâmetros credentialTemplateId, email).
/flows GET Lista os fluxos configurados na sua organização.
/get-organization GET Retorna os metadados da sua organização.

Códigos de resposta que você deve tratar

Código Quando aparece
200 A requisição foi processada com sucesso.
401 Token inválido, expirado, ou o JWT não corresponde a um usuário de API (profile=developer). Revise seu login.
402 Sua organização não tem o plano que habilita o acesso à API. Veja Planos e limites.
406 A requisição não passou na validação (por exemplo, um campo obrigatório ausente ou mal formatado). Revise o corpo em relação ao esquema no Swagger.

Próximo passo


CONTENIDO

Powered By EazyDocs