Saltar para o conteúdo principal

​
API DokStamp

DokStamp é uma plataforma multi-tenant para gestão e emissão de credenciais digitais — diplomas, históricos académicos, certificados de curso e badges digitais. A REST API permite integrar a emissão de credenciais diretamente nos sistemas da sua instituição.

Quick Start

Emita o seu primeiro certificado em menos de 10 minutos.

Ordem de Registo de Entidades

Compreenda a ordem correta para registar entidades antes de emitir certificados.

Referência da API

Referência completa de cada endpoint, parâmetro e campo de resposta.

Ciclo de Vida do Certificado

De rascunho a emitido, revogado e expirado — como os certificados mudam de estado.

​
O que é possível fazer

  • Emitir certificados digitais — associe um estudante, curso e PDF assinado numa credencial verificável
  • Assinar documentos — encaminhe documentos para assinantes externos ou assine institucionalmente com um certificado digital
  • Verificar credenciais — disponibilize um URL público por certificado para verificação por terceiros
  • Emitir Open Badges — emita badges digitais compatíveis com W3C associados a cursos
  • Criar portfólios de estudantes — permita que os estudantes organizem e partilhem as suas credenciais publicamente

​
URL Base

Todos os pedidos à API utilizam o seguinte URL base: 
https://api.dokstamp.eu

​
Visão geral da autenticação

A API utiliza autenticação via Bearer token (JWT via Laravel Passport). Obtenha um token enviando as suas credenciais para POST /auth/login. Os tokens têm longa duração (1 ano) e podem ser renovados com POST /auth/refresh. Todos os endpoints protegidos exigem: 
Authorization: Bearer {seu_access_token}
Accept: application/json
X-Tenant: {seu_tenant_id}
Consulte Autenticação para mais detalhes.

​
Formato da resposta

Todas as respostas devolvem JSON. Respostas bem-sucedidas seguem este envelope: 
{
  "data": { ... },
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42
  }
}
Os erros seguem uma estrutura consistente: 
{
  "message": "The given data was invalid.",
  "errors": {
    "email": ["The email field is required."]
  }
}

​
Precisa de ajuda?

Entre em contacto com o seu gestor de conta ou abra um chamado de suporte através do painel DokStamp.