Certificados externos
Certificados externos acompanha os certificados de cursos emitidos por entidades certificadoras externas: o número do certificado e do cartão, o protocolo, a proposta de aprovação de serviço (PAS) e as datas de envio, de retorno e de entrega. Os endpoints desta página correspondem à tela Certificados externos do módulo Operacional.
A listagem traz apenas certificados não cancelados de cursos com certificação
externa. Cada certificado é identificado pelo id numérico, que vem na listagem.
Situação do certificado
A situação (status_id) é calculada pelo servidor a partir das datas do
certificado. Ela é recalculada a cada atualização:
| Datas preenchidas | status_id | Situação na tela |
|---|---|---|
| Data de entrega do certificado | 3 | Certificado coletado |
| Data de retorno (sem data de entrega) | 2 | Certificado disponível para retirada |
| Data de envio, sem data de retorno nem de entrega | 1 | Certificado aguardando endosso do certificador |
| Nenhuma | vazio | Sem situação |
A situação não é enviada pelo cliente. Ela é gravada no certificado a cada
chamada de POST /operational/external-certificates.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /operational/external-certificates | Lista os certificados externos |
| POST | /operational/external-certificates | Atualiza o acompanhamento de um ou mais certificados |
| GET | /operational/external-certificates/report | Gera a planilha Excel da listagem |
| GET | /operational/external-certificates/customers-vendors | Lista os fornecedores cadastrados |
| GET | /operational/external-certificates/statuses | Lista as situações do certificado externo |
GET /operational/external-certificates
Lista os certificados externos do cliente.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| search | Não | Texto livre, buscado no nome, celular e documento do aluno, no curso, no nome curto do curso, na empresa, nos números de certificado, de certificado externo e de protocolo, na PAS e no código da turma |
| student_name | Não | Parte do nome do aluno |
| course_name | Não | Parte do nome do curso |
| course_code | Não | Código do curso |
| class_code | Não | Código da turma |
| class_uuid | Não | uuid da turma. Lista só os certificados dessa turma |
| student_uuid | Não | uuid do aluno na turma. Lista só os certificados desse aluno |
| protocol_number | Não | Parte do número de protocolo |
| service_approval_proposal | Não | Parte da proposta de aprovação de serviço (PAS) |
| business_name | Não | Parte do nome ou da razão social da empresa do aluno |
| start_date_send | Não | Data inicial do envio, a partir desta data |
| end_date_send | Não | Data final do envio, até esta data |
| start_date_return | Não | Data inicial do retorno, a partir desta data |
| end_date_return | Não | Data final do retorno, até esta data |
| start_date_delivery | Não | Data inicial da entrega do certificado, a partir desta data |
| end_date_delivery | Não | Data final da entrega do certificado, até esta data |
| stored_certificate | Não | 1 para listar só os certificados com arquivo anexado. 0 para os que não têm arquivo |
| column | Não | Coluna para ordenar a lista |
| order | Não | Direção da ordenação: asc ou desc. Use junto com column |
| per_page | Não | Quantidade de registros por página. Veja Convenções |
| page | Não | Número da página, quando per_page for informado |
Sem column e order, a lista vem ordenada pelo nome do aluno.
Resposta
Status 200. Sem per_page, a resposta é uma lista de certificados. Com
per_page, a resposta é paginada. Cada certificado traz id,
training_student_id, certificate_number, external_certificate_number,
protocol_number, service_approval_proposal, send_date, return_date,
certificate_delivery_date, status_id, status_name, observations,
student_name, student_document, student_passport, business_name,
course_name, course_code, class_code, start_date, end_date, file (anexo,
quando houver), user_create_name e user_update_name.
curl "https://api.pedagogo.app/operational/external-certificates?class_code=TR-2026-015&per_page=15&page=1" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"
POST /operational/external-certificates
Atualiza o acompanhamento de um ou mais certificados de uma vez. Os campos
enviados são gravados em todos os certificados informados em ids. Os campos
não enviados não são alterados.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| ids | Sim | Texto ou lista | id dos certificados. Aceita texto separado por vírgula (por exemplo 101,102,103) ou uma lista de números |
| protocol_number | Não | Texto | Número de protocolo |
| service_approval_proposal | Não | Texto | Proposta de aprovação de serviço (PAS) |
| external_certificate_number | Não | Texto | Número do certificado emitido pelo certificador |
| card_number | Não | Texto | Número da carteirinha |
| send_date | Não | Data | Data de envio ao certificador, no formato AAAA-MM-DD |
| return_date | Não | Data | Data de retorno do certificador, no formato AAAA-MM-DD |
| certificate_delivery_date | Não | Data | Data de entrega do certificado, no formato AAAA-MM-DD |
| card_delivery_date | Não | Data | Data de entrega da carteirinha, no formato AAAA-MM-DD |
| observations | Não | Texto | Observações sobre o certificado |
Resposta
Status 200, com uma lista de itens, na mesma ordem dos ids enviados. Cada item
é o certificado atualizado, com os campos do próprio certificado. Um certificado
cancelado não é alterado: o item correspondente traz apenas
{"message": "Não é possível alterar um certificado cancelado"}.
curl -X POST https://api.pedagogo.app/operational/external-certificates \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"ids": "101,102", "send_date": "2026-11-10", "service_approval_proposal": "PAS-EXEMPLO-01"}'
GET /operational/external-certificates/report
Gera a planilha Excel da listagem. Aceita os mesmos parâmetros de
GET /operational/external-certificates.
Resposta
Status 200, com o arquivo .xlsx para download. A planilha traz as colunas da
listagem: turma, curso, datas de início, término e prática, aluno, CPF (com os
dígitos ocultos), passaporte, empresa, CNPJ, números do certificado externo e de
protocolo, PAS, datas de envio, retorno e entrega, situação e observações. O
arquivo é removido do servidor após o envio.
GET /operational/external-certificates/customers-vendors
Lista os fornecedores cadastrados no cliente. Tem o mesmo retorno de
GET /operational/vouchers/vendors, descrito em Vouchers.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| per_page | Não | Quantidade de registros por página |
| page | Não | Número da página, quando per_page for informado |
Resposta
Status 200. Lista de fornecedores, com os campos do cadastro (entre eles id,
uuid e name).
GET /operational/external-certificates/statuses
Lista as situações do certificado externo. O id de cada situação é o valor de
status_id na listagem. A correspondência entre as datas e a situação está na
seção Situação do certificado, no início desta página.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| per_page | Não | Quantidade de registros por página |
| page | Não | Número da página, quando per_page for informado |
Resposta
Status 200. Lista de situações, com os campos id e status (nome da situação).
Sem per_page, a resposta é uma lista simples.