Versão 1

Introdução

A API do Gerar Certificado 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 Gerar Certificado 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://gerarcertificado.com.br/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
tipo 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: Ativos ou Utilizados Ativos

Solicitação de exemplo

https://gerarcertificado.com.br/API/credits/V1/?tipo=Utilizados

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://gerarcertificado.com.br/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://gerarcertificado.com.br/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://gerarcertificado.com.br/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
nomeModelo Obrigatório Especifica qual o modelo de certificado deseja obter o identificador único Modelo simples cinza

Solicitação de exemplo

https://gerarcertificado.com.br/API/models/getId/V1/?nomeModelo=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://gerarcertificado.com.br/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://gerarcertificado.com.br/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://gerarcertificado.com.br/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
idModel Obrigatório Especifica através do identificador único qual o modelo de certificado solicitado 10

Solicitação de exemplo

https://gerarcertificado.com.br/API/models/getById/V1/?idModel=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",
    "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://gerarcertificado.com.br/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
idModeloCertificado Obrigatório Especifica através do identificador único qual o modelo de certificado será editado 10
margemSuperior 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
margemEsquerda 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
margemDireita 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
nome Obrigatório Especifica qual o nome do modelo Modelo novo
corTextos Obrigatório Especifica em formato hexadecimal qual a cor que o texto interno do certificado deve ser apresentado #000000
AlinhamentoTextos 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
texto 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] 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]
fonte 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
textoVerso 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] 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]
corTextosVerso 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
corFundoVerso 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://gerarcertificado.com.br/API/models/edit/V1/?idModeloCertificado=10&margemSuperior=75&margemEsquerda=70&margemDireita=70&nome=Modelo+novo&corTextos=%23000000&alinhamentoTextos=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://gerarcertificado.com.br/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

idModeloCertificado Obrigatório Especifica através do identificador único qual o modelo de certificado será editado 10
acao 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://gerarcertificado.com.br/API/models/editBackgoundImage/V1/?idModeloCertificado=10&acao=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://gerarcertificado.com.br/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
idModeloCertificado Obrigatório Especifica através do identificador único qual o modelo de certificado será excluído 10

Solicitação de exemplo

https://gerarcertificado.com.br/API/models/delete/V1/?idModeloCertificado=10

Resposta de exemplo

[1]

Grupos de alunos

Crie e edite grupos de alunos para emissão de certificados em sua conta.

Dados de um grupo

Recupera dados de um grupo de alunos de sua conta.

URL do recurso

https://gerarcertificado.com.br/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
idGrupo Obrigatório Especifica através do identificador único qual o grupo de alunos solicitado 10

Solicitação de exemplo

https://gerarcertificado.com.br/API/groups/getById/V1/?idGrupo=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://gerarcertificado.com.br/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://gerarcertificado.com.br/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://gerarcertificado.com.br/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
idGrupo Obrigatório Especifica através do identificador único qual o grupo de alunos será editado 456
idModeloCertificado Obrigatório Especifica através do identificador único qual o modelo de certificado será utilizado 10
titulo Obrigatório Informa o título da palestra/curso para o qual será emitido o certificado de teste Palestra sobre emissão de certificados
professor Opcional Informa o nome completo do professor/instrutor que ministrou a palestra/curso Mariazinha da Silva
data 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
cargaHoraria Obrigatório Informa a quantidade de carga horária em que a palestra/curso foi ministrada 20 horas
variaveisCustomizadas 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://gerarcertificado.com.br/API/groups/edit/V1/?idGrupo=456&idModeloCertificado=10&titulo=Palestra+sobre+assuntos+relevantes&professor=Fulano+de+Tal+dos+Santos+da+Silva&data=20+de+Novembro+de+2022&local=Rio+de+Janeiro+-+RJ&cargaHoraria=12+horas&variaveisCustomizadas=Valor+da+variável+1;Valor+da+variável+2

Resposta de exemplo

[1]

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://gerarcertificado.com.br/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
nome 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
variaveisCustomizadas 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://gerarcertificado.com.br/API/groups/parts/create/V1/?nome=Fulano+de+Tal+dos+Santos&email=fulano@mail.com&variaveisCustomizadas=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://gerarcertificado.com.br/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
excluir 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://gerarcertificado.com.br/API/groups/parts/del/V1/?excluir=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://gerarcertificado.com.br/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
programas 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://gerarcertificado.com.br/API/groups/programs/create/V1/?programas=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://gerarcertificado.com.br/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
excluir 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://gerarcertificado.com.br/API/groups/programs/del/V1/?excluir=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://gerarcertificado.com.br/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://gerarcertificado.com.br/API/groups/certs/test/V1

Resposta de exemplo

{
    "fileBase64": "data:application\/pdf;base64,JVBERi0xLjcKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZp...",
    "url": "https://gerarcertificado.com.br/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://gerarcertificado.com.br/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
enviarPara 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://gerarcertificado.com.br/API/groups/finalize/V1/?enviarPara=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://gerarcertificado.com.br/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
idGrupo Obrigatório Especificado o id do grupo de alunos finalizado que deseja o(s) arquivo(s) 10
idPart Obrigatório Especificado o id do participante/aluno a ser recuperado o arquivo PDF 1500

Solicitação de exemplo

https://gerarcertificado.com.br/API/groups/certs/download/V1/?idGrupo=10&idPart=1500

Resposta de exemplo

{
    "fileBase64": "data:application\/pdf;base64,JVBERi0xLjcKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZp...",
    "url": "https://gerarcertificado.com.br/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://gerarcertificado.com.br/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
idGrupo Obrigatório Especificado o id do grupo de alunos finalizado que deseja solicitar envio do(s) certificado(s) 10
idPart Obrigatório Especificado o id do participante/aluno a ser enviado para a fila de envio 1500

Solicitação de exemplo

https://gerarcertificado.com.br/API/groups/certs/send/V1/?idGrupo=10&idPart=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://gerarcertificado.com.br/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
idModeloCertificado Obrigatório Especifica através do identificador único qual o modelo de certificado deseja utilizar para emitir o teste 2
nome Obrigatório Informa o nome completo do participante/aluno para o qual será emitido o certificado de teste Fulano de Tal
variaveisCustomizadasAluno 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
titulo Obrigatório Informa o título da palestra/curso para o qual será emitido o certificado de teste Palestra sobre emissão de certificados
professor Opcional Informa o nome completo do professor/instrutor que ministrou a palestra/curso Mariazinha da Silva
data 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
cargaHoraria Obrigatório Informa a quantidade de carga horária em que a palestra/curso foi ministrada 20 horas
variaveisCustomizadasCurso 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
programa 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://gerarcertificado.com.br/API/create/test/V1/?idModeloCertificado=2&nome=Fulano+de+Tal&titulo=Palestra+sobre+emissão+de+certificados&professor=Mariazinha+da+Silva&data=20+de+Agosto+de+2020&local=Instituto+Saber+Exemplar&cargaHoraria=20+horas&programa=Matéria+1;Matéria+2;Matéria+3

Resposta de exemplo

{
    "fileBase64": "data:application\/pdf;base64,JVBERi0xLjcKNiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZp...",
    "url": "https://gerarcertificado.com.br/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://gerarcertificado.com.br/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
idModeloCertificado Obrigatório Especifica através do identificador único qual o modelo de certificado deseja utilizar para a emissão 2
nome 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
variaveisCustomizadasAluno 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
enviar Opcional Informa se deseja enviar o certificado gerado automaticamente para o e-mail do participante/aluno informado. Padrão: Não Não
titulo Obrigatório Informa o título da palestra/curso para o qual será emitido o certificado de teste Palestra sobre emissão de certificados
professor Opcional Informa o nome completo do professor/instrutor que ministrou a palestra/curso Mariazinha da Silva
data 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
cargaHoraria Obrigatório Informa a quantidade de carga horária em que a palestra/curso foi ministrada 20 horas
variaveisCustomizadasCurso 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
programa 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://gerarcertificado.com.br/API/create/valid/V1/?idModeloCertificado=2&nome=Fulano+de+Tal&email=fulanodetal@teste.com&enviar=Não&titulo=Palestra+sobre+emissão+de+certificados&professor=Mariazinha+da+Silva&data=20+de+Agosto+de+2020&local=Instituto+Saber+Exemplar&cargaHoraria=20+horas&programa=Matéria+1;Matéria+2;Matéria+3

Resposta de exemplo

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