Documentação da API
- Crie uma aplicação: recebe logo uma chave de testes.
- Faça o primeiro pedido à
https://certifixe.com/api/v1/ com essa chave.
- Quando estiver pronto, crie uma chave de produção e peça os acessos de que precisa.
import requests
resposta = requests.post(
"https://certifixe.com/api/v1/certificates/verify/",
headers={"Authorization": "Bearer cfx_test_..."},
json={"code": "SANDBOX-VALIDO"},
timeout=10,
)
print(resposta.json()["status"]) # valid
Autenticação
Chave de API, para dados públicos e da sua organização: Authorization: Bearer cfx_live_.... Guarde-a num servidor, nunca numa aplicação de browser ou telemóvel. Mostramo-la uma só vez e guardamos apenas o hash. Rodar uma chave mantém a antiga válida 24 horas; revogar corta o acesso de imediato.
OAuth 2.0, para dados de uma pessoa, com a autorização dela: Authorization Code com PKCE obrigatório.
GET https://certifixe.com/oauth/authorize/?response_type=code&client_id=...&redirect_uri=...
&scope=identity:profile identity:credentials&state=...&code_challenge=...&code_challenge_method=S256
POST https://certifixe.com/oauth/token/
grant_type=authorization_code&code=...&redirect_uri=...&client_id=...&client_secret=...&code_verifier=...
Authorization: Bearer <access_token> # válido 1 hora; renove com grant_type=refresh_token (o refresh token roda)
A pessoa pode retirar o acesso em Acessos que autorizei, com efeito imediato.
Escopos
| Escopo | Permite | Quem autoriza |
|---|
certificates:verify | Verificar a autenticidade e o estado de certificados | Qualquer aplicação |
jobs:read | Consultar as vagas publicadas no Certifixe Careers | Qualquer aplicação |
courses:read | Consultar os cursos e instituições públicos do Certifixe Market | Qualquer aplicação |
identity:verify | Confirmar se um identificador do Certifixe ID existe | Equipa Certifixe |
enquiries:write | Enviar pedidos de informação e inscrições do Market, com o consentimento da pessoa | Equipa Certifixe |
identity:profile | Ver o nome, o título profissional e a localidade do seu Certifixe ID | Equipa Certifixe e a pessoa |
identity:credentials | Ver os certificados visíveis do seu Certifixe ID e o estado de cada um | Equipa Certifixe e a pessoa |
identity:skills | Ver as suas competências e quais estão documentadas por certificados | Equipa Certifixe e a pessoa |
applications:read | Ver as suas candidaturas e os seus currículos do Certifixe | Equipa Certifixe e a pessoa |
applications:write | Enviar candidaturas em seu nome, com o que autorizar em cada uma | Equipa Certifixe e a pessoa |
certificates:issue | Emitir certificados em nome do centro, com as regras do sistema | Centro ou empresa |
institution:read | Ver as matrículas e participantes do centro necessários para a emissão | Centro ou empresa |
certificates:events | Receber eventos dos certificados do centro | Centro ou empresa |
applications:events | Receber eventos das candidaturas às vagas da empresa | Centro ou empresa |
Testes (sandbox)
Com uma chave cfx_test_, a mesma API responde com dados fictícios, numa área separada dos dados reais: nada do que faz toca em certificados, pessoas ou vagas reais. Todos os escopos estão disponíveis e não precisa de aprovação.
- Verificação:
SANDBOX-VALIDO, SANDBOX-REVOGADO, SANDBOX-SUBSTITUIDO. O nome do titular de teste é SANDBOX-TESTE-NOME.
- Emissão:
reference_id 9001 (conclusão, titular «Pessoa Sandbox»), 9002 (recusada) e 9101 (participação).
- Vaga
sandbox-contabilista, curso 9001, instituição sandbox-centro, identificador sbx0-0001.
- Webhooks marcados «recebe eventos de testes» recebem os eventos criados no sandbox.
Erros
Todos os erros têm o mesmo formato. Indique o request_id ao suporte.
{"error": {"code": "insufficient_scope", "message": "Esta credencial não tem o escopo jobs:read.",
"request_id": "6f1f7e1c-...", "details": {"required_scope": "jobs:read"}}}
Limites
| Plano | Por minuto | Por dia | Por mês | Emissão |
|---|
| Developer Free | 30 | 1 000 | 10 000 | Não |
| Business API | 120 | 20 000 | 300 000 | Sim |
| Enterprise API | 600 | 200 000 | 3 000 000 | Sim |
As respostas trazem X-RateLimit-Limit e X-RateLimit-Remaining. Acima do limite recebe 429 rate_limited. O ambiente de testes tem contagem separada.
Versionamento
A versão faz parte do caminho (/api/v1/) e vem no cabeçalho X-Certifixe-API-Version. Podemos acrescentar campos e endpoints na v1, por isso ignore os campos que não conhece. Alterações incompatíveis vão para uma nova versão, e a anterior mantém-se.
Geral
GET /api/v1/
Estado da credencial: aplicação, ambiente e escopos
Resposta 200
{
"api": "Certifixe Connect",
"version": "v1",
"sandbox": false,
"scopes": [
"certificates:verify"
]
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
Certificados
POST /api/v1/certificates/verify/
Verificar um certificado: autenticidade, estado e emissor. O titular vai sempre parcial; `holder_name` só confirma se o nome coincide.
Escopo: certificates:verify
Pedido
{
"code": "CFX-2026-AB12-CD34",
"holder_name": "Joana Manuel"
}
Resposta 200
{
"status": "valid",
"authentic": true,
"code": "CFX-2026-AB12-CD34",
"document_type": "conclusao",
"holder": "Joana M.",
"issuer": {
"name": "Centro Exemplo",
"license_status": "validada",
"license_number": "0170.01/2018"
},
"certificate": {
"number": "CF-2026-0012",
"course": "Informática",
"hours": 60,
"completed_on": "2026-06-30",
"issued_on": "2026-07-02"
},
"integrity_seal": "A1B2-C3D4",
"verify_url": "https://certifixe.com/verificar-certificado/CFX-2026-AB12-CD34/",
"holder_name_matches": true
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
POST /api/v1/certificates/issuances/
Emitir um certificado para uma matrícula ou participante existente do centro que autorizou a aplicação. Assíncrono: acompanhe o estado. Planos Business e Enterprise.
Escopo: certificates:issue · autorização do centro
| Parâmetro | Onde | Descrição |
|---|
Idempotency-Key * | cabeçalho | Único por emissão: repetir o pedido devolve a mesma emissão, sem emitir duas vezes. |
Pedido
{
"type": "completion",
"reference_id": 512,
"holder_name": "Joana Manuel",
"institution": "centro-exemplo"
}
Resposta 202
{
"id": "6f1f7e1c-6a1e-4d7b-9f58-0d3f0c7d2b11",
"type": "completion",
"reference_id": 512,
"status": "pending",
"reasons": [],
"code": null,
"number": null,
"institution": "centro-exemplo",
"created_at": "2026-11-04T10:00:00+01:00",
"updated_at": "2026-11-04T10:00:00+01:00"
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
- 409 `idempotency_conflict`: chave repetida com outros dados
- 422 `holder_mismatch`: o nome não coincide com o registo
GET /api/v1/certificates/issuances/{emissao_id}/
Estado da emissão: pending, processing, issued ou rejected (com os motivos, as mesmas regras do sistema).
Escopo: certificates:issue · autorização do centro
| Parâmetro | Onde | Descrição |
|---|
emissao_id * | caminho | |
Resposta 200
{
"id": "6f1f7e1c-6a1e-4d7b-9f58-0d3f0c7d2b11",
"type": "completion",
"reference_id": 512,
"status": "issued",
"reasons": [],
"code": "CFX-2026-AB12-CD34",
"number": "CF-2026-0012",
"institution": "centro-exemplo",
"created_at": "2026-11-04T10:00:00+01:00",
"updated_at": "2026-11-04T10:00:00+01:00"
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/certificates/issuances/{emissao_id}/document/
Descarregar o PDF de uma emissão concluída.
Escopo: certificates:issue · autorização do centro
| Parâmetro | Onde | Descrição |
|---|
emissao_id * | caminho | |
Resposta 200: o ficheiro PDF.
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
- 409 `not_ready`: ainda não emitido
Instituição
GET /api/v1/institution/enrollments/
Matrículas do centro que autorizou a aplicação, para obter o `reference_id`.
Escopo: institution:read · autorização do centro
| Parâmetro | Onde | Descrição |
|---|
institution | query | Slug do centro, se a aplicação tiver vários |
class | query | Id da turma |
status | query | Estado da matrícula |
page | query | Página (a partir de 1) |
page_size | query | Itens por página, até 100 |
Resposta 200
{
"data": [
{
"id": 512,
"holder_name": "Joana Manuel",
"class": "INFO 07H",
"course": "Informática",
"status": "ativa"
}
],
"pagination": {
"page": 1,
"page_size": 25,
"total": 1,
"has_next": false
}
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/institution/workshop-participants/
Participantes de workshops do centro que autorizou a aplicação.
Escopo: institution:read · autorização do centro
| Parâmetro | Onde | Descrição |
|---|
institution | query | Slug do centro, se a aplicação tiver vários |
page | query | Página (a partir de 1) |
page_size | query | Itens por página, até 100 |
Resposta 200
{
"data": [
{
"id": 77,
"holder_name": "Ana Paula",
"event": "Oficina de Excel",
"status": "confirmada"
}
],
"pagination": {
"page": 1,
"page_size": 25,
"total": 1,
"has_next": false
}
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
Identidade
POST /api/v1/identity/verify/
Confirmar se um identificador do Certifixe ID existe. Sem dados da pessoa.
Escopo: identity:verify
Pedido
{
"identifier": "4yp3-nmhf"
}
Resposta 200
{
"exists": true
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/identity/me/
Perfil da pessoa que autorizou (token OAuth).
Escopo: identity:profile · token OAuth da pessoa
Resposta 200
{
"identifier": "4yp3-nmhf",
"name": "Joana Manuel",
"title": "Técnica de Contabilidade",
"municipality": "Talatona",
"province": "luanda",
"updated_at": "2026-11-01T09:00:00+01:00"
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/identity/me/credentials/
Certificados visíveis da pessoa, com a origem e o estado. Nunca documentos nem BI.
Escopo: identity:credentials · token OAuth da pessoa
Resposta 200
{
"data": [
{
"source": "certifixe",
"status": "verificado_certifixe",
"type": "Certificado de conclusão",
"title": "Informática",
"institution": "Centro Exemplo",
"number": "CF-2026-0012",
"date": "2026-07-02",
"hours": 60,
"verification_code": "CFX-2026-AB12-CD34",
"area": null
}
]
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/identity/me/skills/
Competências da pessoa; `documented_by_certificate` distingue as documentadas das só declaradas.
Escopo: identity:skills · token OAuth da pessoa
Resposta 200
{
"data": [
{
"name": "Excel avançado",
"kind": "competencia",
"level": "avancado",
"documented_by_certificate": true
}
]
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/identity/me/resumes/
Currículos da pessoa, para escolher o `resume_id` de uma candidatura.
Escopo: applications:read · token OAuth da pessoa
Resposta 200
{
"data": [
{
"id": 12,
"name": "O meu currículo"
}
]
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
Careers
GET /api/v1/identity/me/applications/
Candidaturas da pessoa que autorizou.
Escopo: applications:read · token OAuth da pessoa
| Parâmetro | Onde | Descrição |
|---|
page | query | Página (a partir de 1) |
page_size | query | Itens por página, até 100 |
Resposta 200
{
"data": [
{
"id": 8,
"job_id": "contabilista-a1b2",
"job_title": "Contabilista Júnior",
"company": "Banco Exemplo",
"status": "em_analise",
"submitted_at": "2026-11-01T09:00:00+01:00",
"updated_at": "2026-11-02T09:00:00+01:00"
}
],
"pagination": {
"page": 1,
"page_size": 25,
"total": 1,
"has_next": false
}
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/jobs/
Vagas publicadas por empresas verificadas.
Escopo: jobs:read
| Parâmetro | Onde | Descrição |
|---|
q | query | Texto livre |
area | query | Área profissional |
province | query | Província |
work_mode | query | presencial, remoto ou hibrido |
contract_type | query | Tipo de contrato |
company | query | Id da empresa |
page | query | Página (a partir de 1) |
page_size | query | Itens por página, até 100 |
Resposta 200
{
"data": [
{
"id": "contabilista-a1b2",
"title": "Contabilista Júnior",
"company": {
"id": "banco-exemplo-c3d4",
"name": "Banco Exemplo"
},
"area": "Finanças",
"province": "luanda",
"municipality": "Talatona",
"work_mode": "hibrido",
"contract_type": "efetivo",
"experience_level": "junior",
"min_education": "curso",
"skills": [
"Excel"
],
"salary": {
"min": null,
"max": null,
"currency": "AOA"
},
"deadline": null,
"published_at": "2026-11-01T09:00:00+01:00"
}
],
"pagination": {
"page": 1,
"page_size": 25,
"total": 1,
"has_next": false
}
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/jobs/{vaga_id}/
Detalhe de uma vaga publicada.
Escopo: jobs:read
| Parâmetro | Onde | Descrição |
|---|
vaga_id * | caminho | |
Resposta 200
{
"id": "contabilista-a1b2",
"title": "Contabilista Júnior",
"company": {
"id": "banco-exemplo-c3d4",
"name": "Banco Exemplo"
},
"area": "Finanças",
"province": "luanda",
"municipality": "Talatona",
"work_mode": "hibrido",
"contract_type": "efetivo",
"experience_level": "junior",
"min_education": "curso",
"skills": [
"Excel"
],
"salary": {
"min": null,
"max": null,
"currency": "AOA"
},
"deadline": null,
"published_at": "2026-11-01T09:00:00+01:00",
"description": "...",
"required": [],
"preferred": [],
"questions": [
{
"index": 0,
"text": "Disponibilidade?",
"required": true
}
]
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
POST /api/v1/jobs/{vaga_id}/applications/
Candidatura em nome da pessoa (token OAuth), com o que ela autorizar nesta candidatura.
Escopo: applications:write · token OAuth da pessoa
| Parâmetro | Onde | Descrição |
|---|
vaga_id * | caminho | |
Pedido
{
"resume_id": 12,
"cover_letter": "Tenho experiência...",
"answers": {
"0": "Imediata"
},
"share_sections": [
"perfil",
"experiencia"
],
"share_contacts": false,
"consent": true
}
Resposta 201
{
"id": 8,
"job_id": "contabilista-a1b2",
"job_title": "Contabilista Júnior",
"company": "Banco Exemplo",
"status": "submetida",
"submitted_at": "2026-11-04T10:00:00+01:00",
"updated_at": "2026-11-04T10:00:00+01:00"
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
- 422 `application_rejected`: já se candidatou, vaga fechada, ...
- 400 `consent_required`
Market
GET /api/v1/courses/
Cursos públicos do Certifixe Market.
Escopo: courses:read
| Parâmetro | Onde | Descrição |
|---|
q | query | Nome ou área |
category | query | Categoria |
province | query | Província |
institution | query | Id da instituição |
page | query | Página (a partir de 1) |
page_size | query | Itens por página, até 100 |
Resposta 200
{
"data": [
{
"id": 210,
"name": "Informática Prática",
"area": "Informática",
"institution": {
"id": "centro-exemplo",
"name": "Centro Exemplo"
},
"hours": 60,
"duration": {
"value": 2,
"unit": "meses"
},
"price": {
"enrollment": "45000.00",
"monthly": null,
"billing": "unico",
"currency": "AOA"
},
"category": "informatica",
"summary": "Do Word ao Excel."
}
],
"pagination": {
"page": 1,
"page_size": 25,
"total": 1,
"has_next": false
}
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/courses/{curso_id}/
Detalhe de um curso, com as turmas publicadas.
Escopo: courses:read
| Parâmetro | Onde | Descrição |
|---|
curso_id * | caminho | |
Resposta 200
{
"id": 210,
"name": "Informática Prática",
"area": "Informática",
"institution": {
"id": "centro-exemplo",
"name": "Centro Exemplo"
},
"hours": 60,
"duration": {
"value": 2,
"unit": "meses"
},
"price": {
"enrollment": "45000.00",
"monthly": null,
"billing": "unico",
"currency": "AOA"
},
"category": "informatica",
"summary": "Do Word ao Excel.",
"classes": [
{
"id": 161,
"name": "Turma A",
"starts_on": "2026-12-01",
"ends_on": "2027-02-01",
"mode": "presencial",
"shift": "manha",
"days": null,
"seats_available": 12
}
],
"description": "...",
"objectives": [],
"skills": [],
"requirements": null,
"payment_methods": []
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
POST /api/v1/courses/{curso_id}/enquiries/
Enviar um pedido de informação, interesse ou inscrição para a fila da instituição. Nunca cria uma matrícula.
Escopo: enquiries:write
| Parâmetro | Onde | Descrição |
|---|
curso_id * | caminho | |
Pedido
{
"type": "inscricao",
"name": "Joana Manuel",
"phone": "923000000",
"email": "joana@exemplo.ao",
"message": "",
"class_id": 161,
"consent": true
}
Resposta 201
{
"id": 40,
"course_id": 210,
"type": "inscricao",
"status": "recebida",
"created_at": "2026-11-04T10:00:00+01:00"
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
- 422 `enquiry_rejected`: dados inválidos ou pedido repetido
- 400 `consent_required`
GET /api/v1/institutions/
Instituições públicas do Market. `kind` distingue licenciada (com documento validado), em verificação, não licenciada e formador independente.
Escopo: courses:read
| Parâmetro | Onde | Descrição |
|---|
q | query | Nome |
province | query | Província |
page | query | Página (a partir de 1) |
page_size | query | Itens por página, até 100 |
Resposta 200
{
"data": [
{
"id": "centro-exemplo",
"name": "Centro Exemplo",
"description": "...",
"province": "luanda",
"municipality": "Talatona",
"kind": "licenciada",
"label": "Instituição licenciada (INEFOP)",
"rating": {
"average": 4.6,
"count": 18
}
}
],
"pagination": {
"page": 1,
"page_size": 25,
"total": 1,
"has_next": false
}
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
GET /api/v1/institutions/{slug}/
Detalhe de uma instituição pública.
Escopo: courses:read
| Parâmetro | Onde | Descrição |
|---|
slug * | caminho | |
Resposta 200
{
"id": "centro-exemplo",
"name": "Centro Exemplo",
"description": "...",
"province": "luanda",
"municipality": "Talatona",
"kind": "licenciada",
"label": "Instituição licenciada (INEFOP)",
"rating": {
"average": 4.6,
"count": 18
}
}
Códigos de erro
- 400 Pedido inválido (`invalid_request`)
- 401 Sem credencial válida (`missing_credentials`, `invalid_credentials`)
- 403 Sem permissão (`insufficient_scope`, `application_suspended`, `user_token_required`, `institution_not_authorized`, `plan_not_allowed`)
- 404 Não encontrado (`not_found`)
- 429 Limite do plano atingido (`rate_limited`) ou demasiadas credenciais inválidas do mesmo IP (`too_many_failed_attempts`)
Webhooks
Eventos disponíveis: application.created, application.status_changed, candidate.profile.updated, certificate.created, certificate.revoked, certificate.updated, course.published, job.published. Os dados são mínimos, sem nomes nem contactos: use a API para obter o que tiver permissão para ver.
{
"id": "0c1d9a5e-7d7a-4c61-b6c7-0f2f1b8a4e22",
"type": "certificate.revoked",
"created_at": "2026-11-04T10:00:00+01:00",
"api_version": "v1",
"sandbox": false,
"data": {
"code": "CFX-2026-AB12-CD34",
"number": "CF-2026-0012",
"institution": "centro-exemplo",
"status": "anulado",
"document_type": "certificado"
}
}
Verifique a assinatura. O cabeçalho X-Certifixe-Signature: t=<epoch>,v1=<hex> tem um HMAC-SHA256 de "<t>.<corpo em bruto>" com o segredo do webhook. Rejeite assinaturas antigas (mais de 5 minutos).
import hashlib, hmac, time
def assinatura_valida(segredo, corpo, cabecalho):
partes = dict(p.split("=", 1) for p in cabecalho.split(","))
esperado = hmac.new(segredo.encode(), f"{partes['t']}.".encode() + corpo, hashlib.sha256).hexdigest()
return hmac.compare_digest(esperado, partes["v1"]) and abs(time.time() - int(partes["t"])) < 300
Não processe duas vezes. Guarde o X-Certifixe-Event-Id: é o mesmo em todas as tentativas do mesmo evento. Responda 2xx em menos de 5 segundos e faça o trabalho depois.
Retentativas. Sem resposta 2xx, tentamos de novo depois de 1 minuto, 5 minutos, 30 minutos, 2 horas e 12 horas. Depois de 20 falhas seguidas o webhook é desativado, e pode reativá-lo no portal, onde está o histórico de entregas. Só aceitamos endereços https públicos.