Documentação para Integração de Recertificações

Modificado em Qui, 25 Jul, 2024 na (o) 6:44 PM

Pré-requisito (IMPORTANTE)

Para utilização dos serviços da API da Engage é necessário ter em mãos os parâmetros abaixo:

username;
password;
customer_id;
customer_token;
client_id;
client_secret.

Para gerar estes parâmetros, siga os procedimentos descritos neste tutorial. Caso tenha alguma dúvida ou enfrente qualquer problema para obtê-los, entre em contato com o Suporte Técnico da Engage através do endereço meajuda@engage.bz

Por fim, é extremamente recomendado que os testes e desenvolvimento da integração sejam feitos utilizando nosso ambiente de HOMOLOGAÇÃO. Aponte a integração para o ambiente produtivo da Engage somente quando ela estiver concluída, testada e homologada.

Ambiente de Homologação

Para desenvolvimento e testes de integração com a plataforma Engage, é disponibilizada abaixo a URL do ambiente de homologação:

https://sandbox.engage.bz/api/v1/

2. Ambiente de Produção

https://my.engage.bz/api/v1/

3. Autenticação

Para obter acesso aos dados disponibilizados pelos serviços da API é necessário fazer a autenticação utilizando o access_token enviado. Como o serviço utiliza o tipo de autenticação HTTP Bearer, o token de acesso deverá ser inserido na propriedade Authorization do cabeçalho HTTP, conforme exemplo abaixo:

Authorization Bearer {access_token}

OBS.: A palavra Bearer deve ser adicionada antes do token e separada por um espaço.

4. POST /auth

Este método deve ser utilizado nos seguintes cenários:

Nos casos em que o login é efetuado no próprio site
Para executar métodos que necessitam de autenticação.

Para acessar os métodos que necessitam de autenticação é preciso enviar o parâmetro access_token como argumento para as requisições, ou guardar o cookie gerado a partir deste método e utilizá-lo nas requisições seguintes.

OBS.: O access_token tem um tempo de vida de 25 minutos. Transcorrido este tempo, ele expira e o acesso aos endpoints é negado – devolvendo o status HTTP 401- Unauthorized – sendo necessário renová-lo a partir de uma nova chamada a este endpoint.

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetro	Tipo	Obrigatório	Valor Padrão	Descrição
grant_type	String	Sim	password	Como a autenticação se dará por usuário e senha, o grant_type a chamada deverá enviar o valor password para este parâmetro.
username	String	Sim	-	Login do usuário.
password	String	Sim	-	Senha do respectivo usuário.
client_id	String	Sim	-	ID da aplicação que está se integrando ao Engage. Esta informação será fornecida pela equipe da Engage.
client_secret	String	Sim	-	Senha da aplicação que está se integrando ao Engage. Esta informação será fornecida pela equipe da Engage.
customer_id	String	Sim	-	ID da instância que representa o ambiente do cliente. Esta informação será fornecida pela equipe da Engage.

OBS: O Content-Type dos parâmetros acima deve ser: application/x-www-form-urlencoded, conforme exemplo abaixo feito através do software Postman:

Retornos:

Em caso de sucesso, o retorno será semelhante ao JSON abaixo:

{

"access_token": "dskdmkdnfi3948339w",

"token_type": "bearer",

"expires_in": 1499,

"client_id": "my_client_id",

"customer_id": "customer_id",

"user_id": "1",

".issued": "Fri, 11 Aug 2018 20:06:53 GMT",

".expires": "Fri, 11 Aug 2018 20:31:53 GMT"

}

Em caso de falha, o retorno será semelhante ao JSON abaixo:

{

"error": "error_code",

"error_description": "This is an error."

}

4.1. Permissões de Acesso

Os acessos aos métodos da API são autorizados com base nas permissões que um determinado possui. Por exemplo, para acessar determinados endpoints, não basta apenas estar autenticado, mas, também, possuir permissão de acesso ao recurso. Por exemplo, para efetuar cadastros de recertificações é necessária permissão “GameManagement” no sistema. Abaixo, segue a lista das principais permissões do sistema.

UserManagement:
ScoreManagement:
GameManagement:
GroupManagement:
AchievementManagement:

5. Ambientes

5.1. GET {customerId}/competitions

Este serviço retorna a lista de ambientes disponíveis na plataforma da Engage.

Para consumir este serviço, é necessário estar autenticado com um usuário que possua a permissão GameManagement, ou seja, durante a chamada a este método, é obrigatório o envio do access_token no Header da requisição de algum usuário que possua esta permissão de acesso. Para maiores detalhes, consulte o capítulo Autenticação.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro	Tipo do Parâmetro	Tipo do Dado	Obrigatório	Descrição
customerId	Path	String	Sim	Id da instância que compõe a rota do endpoint.
skip	Query	Inteiro	Não	Número da página.
take	Body	Inteiro	Não	Tamanho da página. Se não for informada os 10 primeiros items serão retornados.

Retornos:

Em caso de sucesso – HTTP 200 (OK) – o retorno será semelhante ao JSON abaixo:

{

"count": 2,

"results": [

{

" competition_id": 1,

“name”: “Nome do ambiente”,

“description”: “Descrição do ambiente”,

“available”: true

}

]

}

]

}

Onde:

Parâmetro	Tipo de Dado	Descrição
count	Inteiro	Total de itens retornados de acordo com o resultado da pesquisa.
results	Array	Coleção que informa, por item do array, todas os ambientes retornadas pela pesquisa.
competition_id	Inteiro	Id do ambiente.
name	String	Nome do ambiente.
description	String	Descrição do ambiente
available	Boleano	Indica se o ambiente está ativa (true) ou inativa (false)

Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "Não encontrado.",

"message": "Sua pesquisa não retornou resultados.",

"data_occurred": "2017-08-21T13:45:14.2586346-03:00"

}

]

}

5.2. GET {customerId}/competitions/{competitionId}/tracks

Este serviço retorna a lista de trilhas vinculadas aos ambientes informada.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro	Tipo do Parâmetro	Tipo do Dado	Obrigatório	Descrição
customerId	Path	String	Sim	Id da instância que compõe a rota do endpoint.
competitionId	Path	Inteiro	Sim	Id do ambiente que deseja-se obter a lista de trilhas.

Retornos:

Em caso de sucesso – HTTP 200 (OK) – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"results": [

{

"track_id": 1732,

"description": "Minha Trilha",

"status": true,

"is_visible": true,

"type_id": "customhtml",

]

}

Onde:

Parâmetro	Tipo de Dado	Descrição
count	Inteiro	Total de itens retornados de acordo com o resultado da pesquisa.
results	Array	Coleção que informa, por item do array, todas as trilhas vinculadas ao ambiente
track_id	Inteiro	ID da trilha.
description	String	Nome da trilha
status	Boleano	Indica se a trilha está ativa (true) ou inativa (false)
is_visible	Boleano	Indica se a trilha está visível (true) ou invisível (false)
type_id	String	Tipo da trilha. Se é customhtml, lista ou library

Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "Não encontrado.",

"message": "Sua pesquisa não retornou resultados.",

"data_occurred": "2017-08-21T13:45:14.2586346-03:00"

}

]

}

5.3. POST {customerId}/competitions

Este serviço deve ser utilizado para criar novos ambientes no Engage. Para consumir este serviço, é necessário estar autenticado com um usuário que possua a permissão GameManagement, ou seja, durante a chamada a este método, é obrigatório o envio do access_token no Header da requisição de algum usuário que possua esta permissão de acesso. Para maiores detalhes, consulte o capítulo Autenticação.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization: Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro	Tipo do Parâmetro	Tipo do Dado	Obrigatório	Descrição
customerId	Path	String	Sim	Id da instância que compõe a rota do endpoint. Esta informação será fornecida pela equipe da Engage.
competition	Body	Objeto	Sim	Deve ser enviado um objeto JSON no corpo da requisição, conforme exemplo abaixo: { "name": "string", "description": "string" } OBS: Content-Type deste parâmetro deve ser application/json

Onde:

Parâmetro	Tipo de Dado	Obrigatório	Único	Descrição
name	String	Sim	Não	Nome do ambiente
description	String	Não	Sim	Descrição do ambiente

Retornos:

Em caso de sucesso – HTTP 200 (OK) – o retorno será idêntico ao JSON abaixo *:

{

"competition_id": 100,

"name": "Ambiente 1",

"description": “Meu ambiente - Descrição”,

"available": true,

“is_visible”: true

}

Onde:

Parâmetro	Tipo de Dado	Descrição
competition_id	Inteiro	ID gerado, após a criação do ambiente
name	String	Nome do ambiente
description	String	Descrição do ambiente
available	Booleano	Status do ambiente. true, ativo. false, inativo.
is_visible	Booleano	true, se o ambiente estiver visível para o usuário. false, invisível para o usuário.

* A API devolve mais campos, porém os principais são estes. Os demais são controles usados no sistema, que são gerados automaticamente.

Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "unauthorized",

"message": "Você não está autorizado a acessar este recurso."

}

]

}

5.4. PUT {customerId}/competitions/{competitionId}

Este serviço deve ser utilizado para editar ambientes existentes ambientes no Engage. Para consumir este serviço, é necessário estar autenticado com um usuário que possua a permissão GameManagement, ou seja, durante a chamada a este método, é obrigatório o envio do access_token no Header da requisição de algum usuário que possua esta permissão de acesso. Para maiores detalhes, consulte o capítulo Autenticação.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization: Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro	Tipo do Parâmetro	Tipo do Dado	Obrigatório	Descrição
customerId	Path	String	Sim	Id da instância que compõe a rota do endpoint. Esta informação será fornecida pela equipe da Engage.
competitionId	Path	Inteiro	Sim	ID do ambiente que se pretende editar, compondo a rota do endpoint.
competition	Body	Objeto	Sim	Deve ser enviado um objeto JSON no corpo da requisição, conforme exemplo abaixo: { "name": "string", "description": "string" } OBS: Content-Type deste parâmetro deve ser application/json

Onde:

Parâmetro	Tipo de Dado	Obrigatório	Único	Descrição
name	String	Sim	Não	Nome do ambiente
description	String	Não	Sim	Descrição do ambiente

Retornos:

Em caso de sucesso – HTTP 204 (No Content)
Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "unauthorized",

"message": "Você não está autorizado a acessar este recurso."

}

]

}

6. Recertificações

6.1. POST {customerId}/recertification

Este serviço é destinado à criação de novas recertificações na plataforma Engage., as quais servem para estabelecer uma periodicidade na realização de trilhas por parte dos usuários, a fim de "renovar" os seus certificados.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro

Tipo do Parâmetro

Tipo do Dado

Obrigatório

Descrição

customerId

Path

String

Sim

Id da instância que compõe a rota do endpoint. Esta informação será fornecida pela equipe da Engage.

recertification

Body

Objeto

Sim

Deve ser enviado um array de objetos no corpo da requisição, conforme exemplo abaixo:

{

"track_id": number,

"participates_users": boolean,

"mandatory_users": boolean,

"expiration_period_certification_in_days": number,

"avaliable_recertification_period_in_days": number,

"send_notification_track_completed": boolean,

"send_notification_track_avaliable": boolean,

"send_notification_next_expiration": boolean,

"send_notification_expired_track": boolean,

"status": true, "recertification_notification_next_expiration": [

{

"days": 3

{

"days": 7

{

"days": 31

}

]

}

OBS: Content-Type deste parâmetro deve ser application/json

Onde:

Parâmetro	Tipo de Dado	Obrigatório	Descrição
track_id	Number	Sim	Id da Trilha.
participates_users	Boolean	Sim	Indica se irá considerar usuários com perfil de "Participa" para a Recertificação. true considera usuários com este tipo de perfil. false desconsidera usuários com este tipo de perfil
mandatory_users	Boolean	Sim	Indica se irá considerar usuários com perfil de "Obrigatório" para a Recertificação. true considera usuários com este tipo de perfil. false desconsidera usuários com este tipo de perfil
expiration_period_certification_in_days	Number	Sim	Quantidade de dias para expirar uma recertificação. É o parâmetro que será usado para realizar o cálculo da Data de Expiração, acrescentando a quantidade de dias configurada em cima da data de conclusão do usuário.
avaliable_recertification_period_in_days	Number	Sim	Quantidade de dias antes da Expiração, que uma recertificação ficará disponível para realização. É o parâmetro que será usado para realizar o cálculo da Data de Disponível, decrescendo a quantidade de dias configurada em cima da data de expiração da recertificação.
send_notification_track_completed	Boolean	Sim	Indica se irá enviar notificação após a trilha ser concluída pelo usuário. true para enviar a notificação após concluir uma trilha. false para não enviar a notificação, após a conclusão da trilha.
send_notification_track_avaliable	Boolean	Sim	Indica se irá enviar notificação após a trilha ficar disponível para realização do usuário. true para enviar a notificação quando a trilha estiver disponível. false para não enviar a notificação, quando a trilha estiver disponível.
send_notification_expired_track	Boolean	Sim	Indica se irá enviar notificação após a trilha expirar para o usuário. true para enviar a notificação quando a trilha estiver expirada. false para não enviar a notificação, quando a trilha estiver expirada.
status	Boolean	Sim	Status de uma recertificação. Sempre utilizar como true para criar a recertificação como ativa.
send_notification_next_expiration	Boolean	Sim	Indica se irá enviar notificação para o usuário quando estiver próximo da data de expiração. true para enviar a notificação quando a trilha estiver próxima da expiração. false para não enviar a notificação, quando a trilha estiver próxima da expiração. Este parâmetro será usado em combinação com o parâmetro abaixo de "recertification notification next expiration"
recertification_notification_next_expiration	Array	Sim	Array de objetos, que contém os dias antes da expiração, no qual serão usados para enviar a notificação para o usuário. Deve ser algo como: [ { "days": 3 }, { "days": 7 }, { "days": 31 } ]

Abaixo um exemplo da Requisição sendo feita e o retorno:

Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "unauthorized",

"message": "Você não está autorizado a acessar este recurso."

}

]

}

6.2. GET {customerId}/recertification/all

Este serviço deve ser utilizado para consultar as recertificações.

Para consumir este serviço, é necessário estar autenticado, ou seja, durante a chamada a este método, é obrigatório o envio do access_token no Header da requisição. Para maiores detalhes, consulte o capítulo Autenticação.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization: Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro	Tipo do Parâmetro	Tipo do Dado	Obrigatório	Descrição
customerId	Path	String	Sim	Id da instância que compõe a rota do endpoint. Esta informação será fornecida pela equipe da Engage.

Retornos:

Em caso de sucesso – HTTP 200 (OK) – o retorno será semelhante ao JSON abaixo:

{

"count": 2,

"results": [

{

"recertification_id": 51,

"customer_id": "minhainstancia",

"total_users": 15,

"track_name": "Trilha para Recertificação",

"track_id": 123456,

"expiration_time": 365,

"available_time": 60

{

"recertification_id": 55,

"customer_id": "minhainstancia",

"total_users": 43,

"track_name": "The Kings",

"track_id": 17116,

"expiration_time": 180,

"available_time": 25

}

]

}

Onde:

Parâmetro	Tipo de Dado	Descrição
count	Inteiro	Total de itens retornados de acordo com o resultado da pesquisa.
results	Array	Coleção que informa, por item do array, as recertificações cadastradas e ativas na plataforma.
recertification_id	Inteiro	Id da Recertificação.
customer_id	Inteiro	Id da Instância.
total_users	String	Total de Usuários vinculados à recertificação
track_name	String	Nome da Trilha
track_id	Booleano	Id da Trilha
expiration_time	String	Dias para expirar a recertificação, configurado na recertificação
available_time	Inteiro	Dias para a recertificação estar disponível antes da expiração, configurado na recertificação.

Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "Não encontrado.",

"message": "Sua pesquisa não retornou resultados.",

"data_occurred": "2018-08-21T13:45:14.2586346-03:00"

}

]

}

6.3. GET {customerId}/recertification/{recertificationId}

Este serviço deve ser utilizado para consultar uma única recertificação através do Id de Recertificação Informado.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization: Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro	Tipo do Parâmetro	Tipo do Dado	Obrigatório	Descrição
customerId	Path	String	Sim	Id da instância que compõe a rota do endpoint. Esta informação será fornecida pela equipe da Engage.
recertificationId	Path	String	Sim	Id da recertificação que compõe a rota do endpoint.

Retornos:

Em caso de sucesso – HTTP 200 (OK) – o retorno será semelhante ao JSON abaixo:

{

"result": {

"recertification_id": 55,

"track_id": 13126,

"participates_users": true,

"mandatory_users": true,

"active_users": true,

"expiration_period_certification_in_days": 180,

"avaliable_recertification_period_in_days": 25,

"send_notification_track_completed": true,

"send_notification_track_avaliable": true,

"send_notification_next_expiration": true,

"send_notification_expired_track": true,

"status": true,

"registration_date": "2024-01-14T12:25:14.421-03:00",

"last_update_date": "2024-01-29T16:08:17.637-03:00",

"recertification_notification_next_expiration": [

{

"recertification_notification_next_expiration_id": 120,

"recertification_id": 55,

"days": 3

{

"recertification_notification_next_expiration_id": 121,

"recertification_id": 55,

"days": 7

}

"track": {

"track_id": 13126,

"description": "The Kings",

"status": true,

"is_visible": true,

"type_id": "lista",

"file": null,

"thumb": null,

"library_track_id": null,

"can_change_status": false,

"is_main": true,

"number_of_rounds": null,

"ranking_icon": "default",

"is_recurrent": false,

"clone_id": null,

"certificate_id": null,

"certificate_content": null,

"allow_thumbnail": true,

"show_mission_name": true,

"show_mission_date": true,

"show_mission_status": true,

"allow_dark_mode": true,

"enable_line_wrapping_of_modules": null,

"competition_tracks": [

{

"competition_id": 4478,

"competition_name": "Sons of Ragnar",

"track_id": 13126

}

"order": 0,

"certificate_view_rule": "all_rounds_completed",

"allow_back_button": null,

"back_button_url": null,

"external_code": "552113ead7431db0767cdab558108b",

"send_data_via_integration": false,

"show_competition_name_on_track_title": true,

"json_data": null,

"expand_list_height": false,

"expand_list_width": false,

"createdby": "",

"enable_linkedin_button": true

}

Onde:

Parâmetro	Tipo de Dado	Descrição
count	Inteiro	Total de itens retornados de acordo com o resultado da pesquisa.
results	Array	Coleção que informa, por item do array, as recertificações cadastradas e ativas na plataforma.

Em Results, irá retornar as mesmas informações que vimos anteriormente no POST de Recertificações no item 6.1.
Com um adicional de informações referentes a Trilha na qual essa Recertificação está vinculada.

Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "Não encontrado.",

"message": "Sua pesquisa não retornou resultados.",

"data_occurred": "2018-08-21T13:45:14.2586346-03:00"

}

]

}

6.4. PUT {customerId}/recertification/{recertificationId}

Este serviço é destinado à edição de recertificações na plataforma Engage.

Abaixo, segue um exemplo de como o token de acesso deve ser enviado no Header da requisição.

Authorization Bearer {access_token}

Abaixo, seguem descritos os parâmetros que devem ser enviados na requisição.

Parâmetros de Entrada:

Parâmetro

Tipo do Parâmetro

Tipo do Dado

Obrigatório

Descrição

customerId

Path

String

Sim

Id da instância que compõe a rota do endpoint. Esta informação será fornecida pela equipe da Engage.

recertification

Body

Objeto

Sim

Deve ser enviado um array de objetos no corpo da requisição, conforme exemplo abaixo:

{

"track_id": number,

"participates_users": boolean,

"mandatory_users": boolean,

"expiration_period_certification_in_days": number,

"avaliable_recertification_period_in_days": number,

"send_notification_track_completed": boolean,

"send_notification_track_avaliable": boolean,

"send_notification_next_expiration": boolean,

"send_notification_expired_track": boolean,

"status": true, "recertification_notification_next_expiration": [

{

"days": 3

{

"days": 7

{

"days": 30

}

]

}

OBS: Content-Type deste parâmetro deve ser application/json

Onde:

Parâmetro	Tipo de Dado	Obrigatório	Descrição
track_id	Number	Sim	Id da Trilha.
participates_users	Boolean	Sim	Indica se irá considerar usuários com perfil de "Participa" para a Recertificação. true considera usuários com este tipo de perfil. false desconsidera usuários com este tipo de perfil
mandatory_users	Boolean	Sim	Indica se irá considerar usuários com perfil de "Obrigatório" para a Recertificação. true considera usuários com este tipo de perfil. false desconsidera usuários com este tipo de perfil
expiration_period_certification_in_days	Number	Sim	Quantidade de dias para expirar uma recertificação. É o parâmetro que será usado para realizar o cálculo da Data de Expiração, acrescentando a quantidade de dias configurada em cima da data de conclusão do usuário.
avaliable_recertification_period_in_days	Number	Sim	Quantidade de dias antes da Expiração, que uma recertificação ficará disponível para realização. É o parâmetro que será usado para realizar o cálculo da Data de Disponível, decrescendo a quantidade de dias configurada em cima da data de expiração da recertificação.
send_notification_track_completed	Boolean	Sim	Indica se irá enviar notificação após a trilha ser concluída pelo usuário. true para enviar a notificação após concluir uma trilha. false para não enviar a notificação, após a conclusão da trilha.
send_notification_track_avaliable	Boolean	Sim	Indica se irá enviar notificação após a trilha ficar disponível para realização do usuário. true para enviar a notificação quando a trilha estiver disponível. false para não enviar a notificação, quando a trilha estiver disponível.
send_notification_expired_track	Boolean	Sim	Indica se irá enviar notificação após a trilha expirar para o usuário. true para enviar a notificação quando a trilha estiver expirada. false para não enviar a notificação, quando a trilha estiver expirada.
status	Boolean	Sim	Status de uma recertificação. Sempre utilizar como true para criar a recertificação como ativa.
send_notification_next_expiration	Boolean	Sim	Indica se irá enviar notificação para o usuário quando estiver próximo da data de expiração. true para enviar a notificação quando a trilha estiver próxima da expiração. false para não enviar a notificação, quando a trilha estiver próxima da expiração. Este parâmetro será usado em combinação com o parâmetro abaixo de "recertification notification next expiration"
recertification_notification_next_expiration	Array	Sim	Array de objetos, que contém os dias antes da expiração, no qual serão usados para enviar a notificação para o usuário. Deve ser algo como: [ { "days": 3 }, { "days": 7 }, { "days": 30 } ]

Abaixo um exemplo da Requisição sendo feita e o retorno:

Em caso de falha – HTTP 400 (BadRequest), 404 (NotFound), etc – o retorno será semelhante ao JSON abaixo:

{

"count": 1,

"errors": [

{

"error_code": "unauthorized",

"message": "Você não está autorizado a acessar este recurso."

}

]

}

Este artigo foi útil?

Documentação para Integração de Recertificações

Pré-requisito (IMPORTANTE)

Ambiente de Homologação

2. Ambiente de Produção

3. Autenticação

4. POST /auth

5.4. PUT {customerId}/competitions/{competitionId}