Relatórios

Notas
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Obtenha a sua chave API.
Lista

API endpoint:

GET 
https://auditoria.iddigital.pt/public/api/v1/reports

Exemplo do pedido: 

curl --location --request GET 'https://auditoria.iddigital.pt/public/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tipo
Descrição
search
opcional string
The search query.
search_by
opcional string
Procurar por. Possible values are: url para URL. Defaults to: url.
project
opcional string
The project name.
result
opcional string
The report result. Possible values are: good para Bom, decent para Decente, bad para Mau.
sort_by
opcional string
Filtrar por. Possible values are: id para Data criação, generated_at para Date generated, url para URL, result para Resultado. Defaults to: id.
sort
opcional string
Ordenar. Possible values are: desc para Descendente, asc para Ascendente. Defaults to: desc.
per_page
opcional int
Resultados por página. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Mostrar

API endpoint:

GET 
https://auditoria.iddigital.pt/public/api/v1/reports/{id}

Exemplo do pedido: 

curl --location --request GET 'https://auditoria.iddigital.pt/public/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://auditoria.iddigital.pt/public/api/v1/reports

Exemplo do pedido: 

curl --location --request POST 'https://auditoria.iddigital.pt/public/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Tipo
Descrição
url
necessário string
The webpage's URL.
privacy
opcional integer
Report page privacy. Possible values are: 0 para Público, 1 para Privado, 2 para Password. Defaults to: 1.
password
opcional string
The password for the report page. Only works with privacy set to 2.
Actualizar

API endpoint:

PUT PATCH 
https://auditoria.iddigital.pt/public/api/v1/reports/{id}

Exemplo do pedido: 

curl --location --request PUT 'https://auditoria.iddigital.pt/public/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tipo
Descrição
privacy
opcional integer
Report page privacy. Possible values are: 0 para Público, 1 para Privado, 2 para Password.
password
opcional string
The password for the report page. Only works with privacy set to 2.
results
opcional integer
Update the report results. Possible values are: 0 para Não, 1 para Sim. Defaults to: 0.
Eliminar

API endpoint:

DELETE 
https://auditoria.iddigital.pt/public/api/v1/reports/{id}

Exemplo do pedido: 

curl --location --request DELETE 'https://auditoria.iddigital.pt/public/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'