CertsFULL - Documentação API

Versão 1

Introdução
Como obter acesso
Índice

Dados da Conta

Quantidade de créditos
Modelos de certificados
ID de modelo de certificado
Criar modelo de certificado
Dados de modelo de certificado
Editar modelo de certificado
Editar imagem do verso de modelo de certificado
Excluir modelo de certificado

Grupos de alunos

Dados dos últimos grupos finalizados
Dados de um grupo
Dados do grupo não finalizado
Editar grupo não finalizado
Autopreencher dados de grupo de alunos não finalizado
Adicionar aluno ao grupo não finalizado
Excluir aluno do grupo não finalizado
Adicionar conteúdo programático ao grupo não finalizado
Excluir conteúdo programático do grupo não finalizado
Gerar certificado de teste do grupo não finalizado
Finalizar grupo e gerar todos os certificados válidos
Download de certificados emitidos
Solicitar envio de certificados emitidos

Certificados individuais

Gerar certificado de teste
Gerar certificado válido
Validar certificado emitido

Introdução

A API do CertsFULL Angola pode ser utilizada para recuperar dados da conta e/ou gerar certificados tanto de teste quanto válidos.

Como obter acesso

Para fazer solicitações à API do CertsFULL Angola você precisa ter uma conta. No caso de sua conta ser gratuita, nem todas os recursos estarão disponíveis, para transformar sua conta em premium siga para a página de planos e preços e transforme sua conta em premium sem custo.

Conhecer os planos e preços

Dados da conta

Recupere quantidade de créditos utilizados e disponíveis e informações sobre os modelos de certificados disponíveis para a utilização de sua conta.

Quantidade de créditos

Recupere quantidade de créditos utilizados ou disponíveis. Créditos avulsos ou relacionados a assinaturas ativas.

URL do recurso

https://certsfull.com/ao/API/credits/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Valor padrão
type	Opcional	Especifica se deseja receber a quantidade de créditos disponíveis para uso ou a quantidade de créditos já utilizados pela conta. Opções: Active ou Used	Active

Solicitação de exemplo

https://certsfull.com/ao/API/credits/V1/?type=Used

Resposta de exemplo

[{
    "credits": 15,
    "subscriptionCredits": 7
}]

Modelos de certificados

Recupere identificador e nome dos modelos de certificados disponíveis para uso pela conta.

URL do recurso

https://certsfull.com/ao/API/models/getAll/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Solicitação de exemplo

https://certsfull.com/ao/API/models/getAll/V1

Resposta de exemplo

[{
    "models": {
        "publics": [
            {
                "id": 1,
                "nome": "Modelo simples marrom",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            },
            {
                "id": 2,
                "nome": "Modelo simples cinza",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            },
            {
                "id": 3,
                "nome": "Modelo lona azul",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            },
            {
                "id": 4,
                "nome": "Modelo lona marrom",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            },
            {
                "id": 5,
                "nome": "Modelo papel cinza",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            },
            {
                "id": 6,
                "nome": "Modelo papel amarelo",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            },
            {
                "id": 7,
                "nome": "Modelo aquarela",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            },
            {
                "id": 8,
                "nome": "Modelo dourado",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            }
        ],
        "privates": [
            {
                "id": 15,
                "nome": "Modelo personalizado",
                "thumb": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA..."
            }
        ]
    }
}]

ID de Modelo de certificado

Recupere o identificador único de um dos modelos de certificados disponíveis para uso pela conta.

URL do recurso

https://certsfull.com/ao/API/models/getId/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
modelName	Obrigatório	Especifica qual o modelo de certificado deseja obter o identificador único	Modelo simples cinza

Solicitação de exemplo

https://certsfull.com/ao/API/models/getId/V1/?modelName=Modelo+simples+cinza

Resposta de exemplo

[{
    "model id": 2
}]

Criar modelo de certificado

Registre um novo modelo personalizado de certificado para uso em sua conta.

URL do recurso

https://certsfull.com/ao/API/models/create/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
b64	Obrigatório	Imagem JPG codificado em formato Base64	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA...

Solicitação de exemplo

https://certsfull.com/ao/API/models/create/V1/?b64=data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA...

Resposta de exemplo

[10]

Dados de modelo de certificado

Recupera dados de um modelo personalizado de certificado de uso exclusivo de sua conta.

URL do recurso

https://certsfull.com/ao/API/models/getById/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
modelId	Obrigatório	Especifica através do identificador único qual o modelo de certificado solicitado	10

Solicitação de exemplo

https://certsfull.com/ao/API/models/getById/V1/?modelId=10

Resposta de exemplo

[{
    "id": "10",
    "name": "Nome do modelo",
    "image": "data:image\/jpeg;base64,\/9j\/4AAQSkZJRgABAQEASABIAAD\/2wBDAAEBAQEBA...",
    "thumb": "data:image\/jpeg;base64,\/9j\/4AAQSkZJRgABAQEAYABgAAD\/\/gA7Q1JFQVRP...",
    "marginTop": 85,
    "marginLeft": 70,
    "marginRight": 70,
    "text": "",
    "textColor": "#fe9900",
    "textAlign": "center",
    "font": "alexbrush",
    "verseTitle": "Conteúdo programático",
    "verseText": "",
    "verseTextColor": "#000000",
    "verseBackgroundColor": "#d0ae8a"
}]

Editar modelo de certificado

Edita um modelo personalizado de certificado de uso exclusivo de sua conta.

URL do recurso

https://certsfull.com/ao/API/models/edit/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
modelId	Obrigatório	Especifica através do identificador único qual o modelo de certificado será editado	10
topMargin	Obrigatório	Especifica qual o tamanho em milímetros entre a linha superior da caixa de texto até o limite superior de uma folha A4 em formato paisagem	70
leftMargin	Obrigatório	Especifica qual o tamanho em milímetros entre a linha esquerda da caixa de texto até o limite esquerda de uma folha A4 em formato paisagem	35
rightMargin	Obrigatório	Especifica qual o tamanho em milímetros entre a linha direita da caixa de texto até o limite direita de uma folha A4 em formato paisagem	35
name	Obrigatório	Especifica qual o nome do modelo	Modelo novo
textColor	Obrigatório	Especifica em formato hexadecimal qual a cor que o texto interno do certificado deve ser apresentado	#000000
textAlignment	Obrigatório	Especifica o alinhamento em que o texto interno do certificado deve ser apresentado. Podendo utilizar as seguintes possibilidades: left, center ou right	center
text	Opcional	Especifica qual o texto personalizado que compõe o corpo do certificado. Podendo utilizar as seguintes variáveis: [NOME_PARTICIPANTE_ALUNO], [NOME_PALESTRA_CURSO], [NOME_PALESTRANTE_PROFESSOR], [DATA_PALESTRA_CURSO], [LOCAL_REALIZACAO], [CARGA_HORARIA], [DATA_EMISSAO_CERTIFICADO] e demais variáveis personalizadas da conta.	Certificamos que [NOME_PARTICIPANTE_ALUNO] participou da palestra/curso [NOME_PALESTRA_CURSO] ministrada por [NOME_PALESTRANTE_PROFESSOR] realizado(a) [DATA_PALESTRA_CURSO], [LOCAL_REALIZACAO] Com carga horária de [CARGA_HORARIA]
font	Opcional	Especifica qual a fonte a ser utilizada no texto no nome do aluno/participante (Apenas para contas com assinaturas ativas), entre as opções: Roboto, Merriweather, alexbrush, greatvibes, pacifico ou lobster	Merriweather
backTitle	Opcional	Especifica qual o título personalizado para a área de conteúdo programático (Apenas para contas com assinaturas ativas). Mínimo de 5 e máximo de 72 caracteres.	Programas do curso
backText	Opcional	Especifica qual o texto personalizado que compõe a área lateral do verso do certificado (Apenas para contas com assinaturas ativas). Podendo utilizar as seguintes variáveis: [NOME_PARTICIPANTE_ALUNO], [NOME_PALESTRA_CURSO], [NOME_PALESTRANTE_PROFESSOR], [DATA_PALESTRA_CURSO], [LOCAL_REALIZACAO], [CARGA_HORARIA], [DATA_EMISSAO_CERTIFICADO] e demais variáveis personalizadas da conta.	Certificado concedido a: [NOME_PARTICIPANTE_ALUNO] Que obteve nota [NOTA] Palestra/curso: [NOME_PALESTRA_CURSO] Carga horária: [CARGA_HORARIA]
backTextColor	Opcional	Especifica em formato hexadecimal qual a cor que o texto do verso do certificado deve ser apresentado (Apenas para contas com assinaturas ativas).	#000000
backBackgroundColor	Opcional	Especifica em formato hexadecimal qual a cor que o fundo do verso do certificado deve ser apresentado (Apenas para contas com assinaturas ativas).	#FFFFFF

Solicitação de exemplo

https://certsfull.com/ao/API/models/edit/V1/?modelId=10&topMargin=75&leftMargin=70&rightMargin=70&name=Modelo+novo&textColor=%23000000&textAlignment=left

Resposta de exemplo

[1]

Editar imagem do verso de modelo de certificado

Envia, exclui ou substitui uma imagem de verso de um modelo personalizado de certificado de uso exclusivo de sua conta.

URL do recurso

https://certsfull.com/ao/API/models/editBackgoundImage/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

modelId	Obrigatório	Especifica através do identificador único qual o modelo de certificado será editado	10
action	Obrigatório	Especifica se deseja cadastrar/substituir a imagem de fundo ou se deseja excluir a imagem atual (Apenas para contas com assinaturas ativas). Opções: Add ou Del	Add
b64	Obrigatório se a ação for de cadastro (Add)	Imagem JPG codificado em formato Base64	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA...

Solicitação de exemplo

https://certsfull.com/ao/API/models/editBackgoundImage/V1/?modelId=10&action=Add&b64=data:image/jpeg;base64,/9j/4AAQSkZJRgABAQA...

Resposta de exemplo

[1]

Excluir modelo de certificado

Exclui um modelo personalizado de certificado de uso exclusivo de sua conta.

URL do recurso

https://certsfull.com/ao/API/models/delete/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
modelId	Obrigatório	Especifica através do identificador único qual o modelo de certificado será excluído	10

Solicitação de exemplo

https://certsfull.com/ao/API/models/delete/V1/?modelId=10

Resposta de exemplo

[1]

Grupos de alunos

Recupere dados, crie e edite grupos de alunos para emissão de certificados em sua conta.

Dados dos últimos grupos finalizados

Recupera alguns dados dos últimos 30 grupos de alunos finalizados de sua conta.

URL do recurso

https://certsfull.com/ao/API/groups/getFinished/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Solicitação de exemplo

https://certsfull.com/ao/API/groups/getFinished/V1

Resposta de exemplo

[{
    "groups": [
        {
            "id": "33539",
            "issueDate": "2024-08-02 11:55:21",
            "titleCourse": "Palestra sobre emiss\u00e3o de certificados"
        },
        {
            "id": "3358",
            "issueDate": "2023-07-28 08:46:40",
            "titleCourse": "Palestra sobre assuntos relevantes"
        },
        ...
        {
            "id": "1056",
            "issueDate": "2021-10-14 19:02:09",
            "titleCourse": "Palestra sobre assuntos relevantes"
        }
    ]
}]

Dados de um grupo

Recupera dados de um grupo de alunos de sua conta.

URL do recurso

https://certsfull.com/ao/API/groups/getById/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
groupId	Obrigatório	Especifica através do identificador único qual o grupo de alunos solicitado	10

Solicitação de exemplo

https://certsfull.com/ao/API/groups/getById/V1/?groupId=9

Resposta de exemplo

[{
    "id": "9",
    "finished": "1",
    "titleGroup": "Palestra sobre assuntos relevantes",
    "coachGroup": "Fulano de Tal",
    "dateGroup": "20\/11\/2022 a 22\/11\/2022",
    "localGroup": "Rio de Janeiro\/RJ",
    "workloadGroup": "12 horas",
    "numberParts": 3,
    "datas": [
        {
            [NOME_PALESTRA_CURSO]: "Palestra sobre assuntos relevantes",
            [NOME_PALESTRANTE_PROFESSOR]: "Fulano de Tal",
            [CARGA_HORARIA]: "12 horas",
            [DATA_PALESTRA_CURSO]: "20\/11\/2022 a 22\/11\/2022",
            [LOCAL_REALIZACAO]: "Rio de Janeiro\/RJ",
            ...
        }
    ],
    "parts": [
        {
            "id": "8206",
            "name": "Fulano de Tal dos Santos Silva",
            "email": "fulano@mail.com",
            "createDate": "2022-11-30 13:25:08",
            "emailSend": "0"
        },
        {
            "id": "8207",
            "name": "Mariazinha de Souza",
            "email": "mariazinha@mail.com",
            "createDate": "2022-11-30 13:25:08",
            "emailSend": "1",
            "sendDate": "In the submission queue"
        },
        {
            "id": "8208",
            "name": "Joãzinho do Rosálio",
            "email": "joaozinho@mail.com",
            "createDate": "2022-11-30 13:25:08",
            "emailSend": "1",
            "sendDate": "2022-11-30 13:27:15"
        }
    ],
    "numberPrograms": 2,
    "programs": [
        {
            "text": "Matéria 1"
        },
        {
            "text": "Matéria 2"
        }
    ]
}]

Dados do grupo não finalizado

Recupera dados do grupo de alunos não finalizado de sua conta. Caso não exista um grupo em aberto esta solicitação abrirá um novo.

URL do recurso

https://certsfull.com/ao/API/groups/getOpen/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Solicitação de exemplo

https://certsfull.com/ao/API/groups/getOpen/V1/

Resposta de exemplo

[{
    "id": "10",
    "finished": "0",
    "titleGroup": "Palestra sobre assuntos relevantes",
    "coachGroup": "Fulano de Tal",
    "dateGroup": "20\/11\/2022 a 22\/11\/2022",
    "localGroup": "Rio de Janeiro\/RJ",
    "workloadGroup": "12 horas",
    "numberParts": 2,
    "datas": [
        {
            [NOME_PALESTRA_CURSO]: "Palestra sobre assuntos relevantes",
            [NOME_PALESTRANTE_PROFESSOR]: "Fulano de Tal",
            [CARGA_HORARIA]: "12 horas",
            [DATA_PALESTRA_CURSO]: "20\/11\/2022 a 22\/11\/2022",
            [LOCAL_REALIZACAO]: "Rio de Janeiro\/RJ",
            ...
        }
    ],
    "parts": [
        {
            "id": "8206",
            "name": "Fulano de Tal dos Santos Silva",
            "email": "fulano@mail.com"
        },
        {
            "id": "8207",
            "name": "Mariazinha da Silva",
            "email": "maria@mail.com"
        }
    ],
    "numberPrograms": 2,
    "programs": [
        {
            "id": "139",
            "text": "Matéria 1"
        },
        {
            "id": "140",
            "text": "Matéria 2"
        }
    ]
}]

Editar grupo de alunos não finalizado

Edita um grupo de alunos em aberto de sua conta.

URL do recurso

https://certsfull.com/ao/API/groups/edit/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
groupId	Obrigatório	Especifica através do identificador único qual o grupo de alunos será editado	456
modelId	Obrigatório	Especifica através do identificador único qual o modelo de certificado será utilizado	10
title	Obrigatório	Informa o título da palestra/curso para o qual será emitido o certificado de teste	Palestra sobre emissão de certificados
teacher	Opcional	Informa o nome completo do professor/instrutor que ministrou a palestra/curso	Mariazinha da Silva
date	Obrigatório	Informa a data que ocorreu a palestra/curso	20 de Agosto de 2020
local	Opcional	Informa o local onde ocorreu a palestra/curso	Instituto Saber Exemplar
workload	Obrigatório	Informa a quantidade de carga horária em que a palestra/curso foi ministrada	20 horas
customVariables	Opcional	Informa quais os valores para cada respectiva variável customizada de curso. A ordem deve ser a de cadastro das variáveis (Apenas para contas com assinaturas ativas).	Valor da variável 1; Valor da variável 2

Solicitação de exemplo

https://certsfull.com/ao/API/groups/edit/V1/?groupId=456&modelId=10&title=Palestra+sobre+assuntos+relevantes&teacher=Fulano+de+Tal+dos+Santos+da+Silva&date=20+de+Novembro+de+2022&local=Rio+de+Janeiro+-+RJ&workload=12+horas&customVariables=Valor+da+variável+1;Valor+da+variável+2

Resposta de exemplo

[1]

Autopreencher dados de grupo de alunos não finalizado

Edita um grupo de alunos em aberto de sua conta autopreenchendo com informações de um grupo anterior já finalizado. Os dados autopreenchidos serão os de "título", "professor", "data", "local", "carga horária" e todas as variáveis customizadas, além de autopreencher o conteúdo programático (verso do certificado).

URL do recurso

https://certsfull.com/ao/API/groups/autofill/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
groupId	Obrigatório	Especifica através do identificador único qual o grupo de alunos será autopreenchido	456
groupFinishedId	Obrigatório	Especifica através do identificador único qual o grupo de alunos já finalizado terá seus dados copiados	450

Solicitação de exemplo

https://certsfull.com/ao/API/groups/autofill/V1/?groupId=456&groupFinishedId=450

Resposta de exemplo

[{
    "id": "456",
    "finished": "0",
    "titleGroup": "Palestra sobre assuntos relevantes",
    "coachGroup": "Fulano de Tal",
    "dateGroup": "20\/11\/2022 a 22\/11\/2022",
    "localGroup": "Rio de Janeiro\/RJ",
    "workloadGroup": "12 horas",
    "datas": [
        {
            [NOME_PALESTRA_CURSO]: "Palestra sobre assuntos relevantes",
            [NOME_PALESTRANTE_PROFESSOR]: "Fulano de Tal",
            [CARGA_HORARIA]: "12 horas",
            [DATA_PALESTRA_CURSO]: "20\/11\/2022 a 22\/11\/2022",
            [LOCAL_REALIZACAO]: "Rio de Janeiro\/RJ",
            ...
        }
    ],
    "numberPrograms": 2,
    "programs": [
        {
            "id": "139",
            "text": "Matéria 1"
        },
        {
            "id": "140",
            "text": "Matéria 2"
        }
    ]
}]

Adicionar aluno ao grupo não finalizado

Registre um novo aluno a um grupo de alunos não finalizado em sua conta.

URL do recurso

https://certsfull.com/ao/API/groups/parts/create/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
name	Obrigatório	Especificado o nome completo do participante/aluno	Fulano de Tal dos Santos
email	Opcional	Especificado o e-mail do participante/aluno	fulano@mail.com
customVariables	Opcional	Informa quais os valores para cada respectiva variável customizada de aluno. A ordem deve ser a de cadastro das variáveis (Apenas para contas com assinaturas ativas).	Valor da variável 1; Valor da variável 2

Solicitação de exemplo

https://certsfull.com/ao/API/groups/parts/create/V1/?name=Fulano+de+Tal+dos+Santos&email=fulano@mail.com&customVariables=Valor+da+variável+1;Valor+da+variável+2

Resposta de exemplo

[10]

Excluir aluno do grupo não finalizado

Exclua o registro de um aluno ou todos os alunos de um grupo de alunos não finalizado em sua conta.

URL do recurso

https://certsfull.com/ao/API/groups/parts/del/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
delete	Obrigatório	Especificado o id do participante/aluno a ser excluído ou especifica que todos devem ser excluídos	10 (para um aluno específico) ou ALL (para todos os alunos)

Solicitação de exemplo

https://certsfull.com/ao/API/groups/parts/del/V1/?delete=10

Resposta de exemplo

[1]

Adicionar conteúdo programático ao grupo não finalizado

Registre um novo conteúdo programático a um grupo de alunos não finalizado em sua conta ou solicite emissão do verso do certificado em branco. Este recurso exige uma habilitação em sua conta.

URL do recurso

https://certsfull.com/ao/API/groups/programs/create/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
programs	Obrigatório (depende de ativação do recurso na conta)	Informa o conteúdo programático no verso do certificado (limitado ao máximo de 28 itens, separados por "ponto e vírgula"). Envie apenas a palavra "vazio" (sem aspas) para sinalizar a emissão do verso do certificado em branco.	Matéria 1; Matéria 2; Matéria 3

Solicitação de exemplo

https://certsfull.com/ao/API/groups/programs/create/V1/?programs=Matéria+1;Matéria+2;Matéria+3

Resposta de exemplo

[1]

Excluir conteúdo programático do grupo não finalizado

Exclua o registro de um programa ou todo o conteúdo programático de um grupo de alunos não finalizado em sua conta.

URL do recurso

https://certsfull.com/ao/API/groups/programs/del/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
delete	Obrigatório	Especificado o id do programa a ser excluído ou especifica que todos devem ser excluídos	10 (para um programa específico) ou ALL (para todos os programas)

Solicitação de exemplo

https://certsfull.com/ao/API/groups/programs/del/V1/?delete=10

Resposta de exemplo

[1]

Gerar certificado de teste do grupo não finalizado

Emita um certificado de teste gratuito para verificação antes da emissão dos certificados válidos do grupo não finalizado.

URL do recurso

https://certsfull.com/ao/API/groups/certs/test/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Solicitação de exemplo

https://certsfull.com/ao/API/groups/certs/test/V1

Resposta de exemplo

{
    "fileBase64": "data:application\/pdf;base64,JVBERi0xLjcKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZp...",
    "url": "https://certsfull.com/ao/export/d7f98f85725947c1d3db20a1e0da7c2b.pdf",
    "available until": "2020-10-11 20:43:58"
}

Finalizar grupo e gerar todos os certificados válidos

Emita os certificados válidos para todos alunos do grupo e finalize-o.

URL do recurso

https://certsfull.com/ao/API/groups/finalize/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Sim (1 crédito por emissão e mais 1 crédito caso opte pelo envio automático)

Parâmetros

Nome	Requerido	Descrição	Exemplo
sendTo	Opcional	Informa os ids dos participantes/alunos que deverão receber o certificado automaticamente no e-mail (separados por "ponto e vírgula")	152;153;15487

Solicitação de exemplo

https://certsfull.com/ao/API/groups/finalize/V1/?sendTo=152;153;15487

Resposta de exemplo

{
    "groupId": 68,
    "finalized": 1,
    "numberEmitCerts": 5,
    "numberCertsToSend": 3
}

Download de certificado emitido

Recupere um arquivo de um certificado válido emitido por sua conta

URL do recurso

https://certsfull.com/ao/API/groups/certs/download/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
groupId	Obrigatório	Especificado o id do grupo de alunos finalizado que deseja o(s) arquivo(s)	10
partId	Obrigatório	Especificado o id do participante/aluno a ser recuperado o arquivo PDF	1500

Solicitação de exemplo

https://certsfull.com/ao/API/groups/certs/download/V1/?groupId=10&partId=1500

Resposta de exemplo

{
    "fileBase64": "data:application\/pdf;base64,JVBERi0xLjcKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZp...",
    "url": "https://certsfull.com/ao/export/d7f98f85725947c1d3db20a1e0da7c2b.pdf",
    "availableUntil": "2020-10-11 20:43:58",
    "suggestedName": "Certificado_Fulano-de-Tal_b54c129d10563cc5a847dfb53c150f12.pdf"
}

Solicitar envio de certificados emitidos

Solicite o envio de um certificado válido emitido por sua conta

URL do recurso

https://certsfull.com/ao/API/groups/certs/send/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Sim (1 crédito)

Parâmetros

Nome	Requerido	Descrição	Exemplo
groupId	Obrigatório	Especificado o id do grupo de alunos finalizado que deseja solicitar envio do(s) certificado(s)	10
partId	Obrigatório	Especificado o id do participante/aluno a ser enviado para a fila de envio	1500

Solicitação de exemplo

https://certsfull.com/ao/API/groups/certs/send/V1/?groupId=10&partId=1500

Resposta de exemplo

{
    "return": "Certificate inserted in the sending queue to the email [emaildoparticipante@dominio]"
}

Certificados individuais

Emita certificados individuais de teste e válidos através de sua conta.

Gerar certificado de teste

Emita um certificado de teste gratuito para verificação antes da emissão de um certificado válido. Este mesmo recurso está disponível para um grupo de alunos não finalizado (consulte documentação)

URL do recurso

https://certsfull.com/ao/API/create/test/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
modelId	Obrigatório	Especifica através do identificador único qual o modelo de certificado deseja utilizar para emitir o teste	2
name	Obrigatório	Informa o nome completo do participante/aluno para o qual será emitido o certificado de teste	Fulano de Tal
participantCustomVariables	Opcional	Informa quais os valores para cada respectiva variável customizada de aluno. A ordem deve ser a de cadastro das variáveis (Apenas para contas com assinaturas ativas).	Valor da variável 1; Valor da variável 2
title	Obrigatório	Informa o título da palestra/curso para o qual será emitido o certificado de teste	Palestra sobre emissão de certificados
teacher	Opcional	Informa o nome completo do professor/instrutor que ministrou a palestra/curso	Mariazinha da Silva
date	Obrigatório	Informa a data que ocorreu a palestra/curso	20 de Agosto de 2020
local	Opcional	Informa o local onde ocorreu a palestra/curso	Instituto Saber Exemplar
workload	Obrigatório	Informa a quantidade de carga horária em que a palestra/curso foi ministrada	20 horas
courseCustomVariables	Opcional	Informa quais os valores para cada respectiva variável customizada de curso. A ordem deve ser a de cadastro das variáveis (Apenas para contas com assinaturas ativas).	Valor da variável 1; Valor da variável 2
programs	Opcional (depende de ativação do recurso na conta)	Informa o conteúdo programático no verso do certificado (limitado ao máximo de 28 itens, separados por "ponto e vírgula"). Envie apenas a palavra "vazio" (sem aspas) para sinalizar a emissão do verso do certificado em branco.	Matéria 1; Matéria 2; Matéria 3

Solicitação de exemplo

https://certsfull.com/ao/API/create/test/V1/?modelId=2&name=Fulano+de+Tal&title=Palestra+sobre+emissão+de+certificados&teacher=Mariazinha+da+Silva&date=20+de+Agosto+de+2020&local=Instituto+Saber+Exemplar&workload=20+horas&programs=Matéria+1;Matéria+2;Matéria+3

Resposta de exemplo

{
    "fileBase64": "data:application\/pdf;base64,JVBERi0xLjcKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZp...",
    "url": "https://certsfull.com/ao/export/d7f98f85725947c1d3db20a1e0da7c2b.pdf",
    "available until": "2020-10-11 20:43:58"
}

Gerar certificado válido

Emita um certificado válido. Para grupos com mais de um participante/aluno prefira utilizar o recurso de criação de grupos (consulte documentação)

URL do recurso

https://certsfull.com/ao/API/create/valid/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Sim (1 crédito por emissão e mais 1 crédito caso opte pelo envio automático)

Parâmetros

Nome	Requerido	Descrição	Exemplo
modelId	Obrigatório	Especifica através do identificador único qual o modelo de certificado deseja utilizar para a emissão	2
name	Obrigatório	Informa o nome completo do participante/aluno para o qual será emitido o certificado	Fulano de Tal
email	Opcional	Informa o e-mail do participante/aluno para o qual será enviado o certificado caso opte por este recurso	fulanodetal@teste.com
participantCustomVariables	Opcional	Informa quais os valores para cada respectiva variável customizada de aluno. A ordem deve ser a de cadastro das variáveis (Apenas para contas com assinaturas ativas).	Valor da variável 1; Valor da variável 2
send	Opcional	Informa se deseja enviar o certificado gerado automaticamente para o e-mail do participante/aluno informado. Padrão: No	No (para não enviar) ou Yes (para enviar)
title	Obrigatório	Informa o título da palestra/curso para o qual será emitido o certificado de teste	Palestra sobre emissão de certificados
teacher	Opcional	Informa o nome completo do professor/instrutor que ministrou a palestra/curso	Mariazinha da Silva
date	Obrigatório	Informa a data que ocorreu a palestra/curso	20 de Agosto de 2020
local	Opcional	Informa o local onde ocorreu a palestra/curso	Instituto Saber Exemplar
workload	Obrigatório	Informa a quantidade de carga horária em que a palestra/curso foi ministrada	20 horas
courseCustomVariables	Opcional	Informa quais os valores para cada respectiva variável customizada de curso. A ordem deve ser a de cadastro das variáveis (Apenas para contas com assinaturas ativas).	Valor da variável 1; Valor da variável 2
programs	Opcional (depende de ativação do recurso na conta)	Informa o conteúdo programático no verso do certificado (limitado ao máximo de 28 itens, separados por "ponto e vírgula"). Envie apenas a palavra "vazio" (sem aspas) para sinalizar a emissão do verso do certificado em branco.	Matéria 1; Matéria 2; Matéria 3

Solicitação de exemplo

https://certsfull.com/ao/API/create/valid/V1/?modelId=2&name=Fulano+de+Tal&email=fulanodetal@teste.com&send=No&title=Palestra+sobre+emissão+de+certificados&teacher=Mariazinha+da+Silva&date=20+de+Agosto+de+2020&local=Instituto+Saber+Exemplar&workload=20+horas&programs=Matéria+1;Matéria+2;Matéria+3

Resposta de exemplo

{
    "groupId": 33539,
    "partId": 648465,
    "fileBase64": "data:application\/pdf;base64,JVBERi0xLjcKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9...",
    "url": "https://certsfull.com/ao/export/80bc623a67bae6433583897e4001833d.pdf",
    "available until": "2020-10-11 21:02:57",
    "suggested name": "Certificado_Fulano-de-Tal_0a9fba0b9d25e94d580d79f9bc1d5a3f.pdf"
}

Validar certificado emitido

Valide um certificado emitido por sua conta a partir do código de validação de cada certificado.

URL do recurso

https://certsfull.com/ao/API/validate/V1

Informação do recurso

Formato de resposta	JSON
Requer autenticação?	Sim (Basic authentication - Login e senha da conta)
Utiliza créditos?	Não

Parâmetros

Nome	Requerido	Descrição	Exemplo
hash	Obrigatório	Informa o código de validação do certificado.	9c63817befe679ea04487af9c8a16c24

Solicitação de exemplo

https://certsfull.com/ao/API/validate/V1/?hash=9c63817befe679ea04487af9c8a16c24

Resposta de exemplo

{
    "certificate": {
        "namePart": "Fulano de Tal dos Santos Silva",
        "titleCourse": "Palestra sobre assuntos relevantes",
        "coachCourse": "Fulano de Tal",
        "dateCourse": "20\/11\/2022 a 22\/11\/2022",
        "localCourse": "Rio de Janeiro\/RJ",
        "workloadCourse": "12 horas"
    },
    "issuer": {
        "emission": "2022-11-30 13:25:08",
        "type": "PJ",
        "companyName": "Nome fantasia ou razão social LTDA.",
        "companyDoc": "00.000.000/0000-00",
        "issuedBy": "Fulano ** ***",
        "issuedDoc": "000.***.***-00",
        "issuedEmail": "gmattje@gmail.com"
    }
}