Relatórios

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

API endpoint:

GET 
https://auditoria-digital.pt/api/v1/reports

Request example: 

curl --location --request GET 'https://auditoria-digital.pt/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 for URL. Defaults to: url.
project
opcional string
The project name.
result
opcional string
The report result. Possible values are: good for Bom, decent for Razoável, bad for Mau.
sort_by
opcional string
Filtrar por. Possible values are: id for Criado em, generated_at for Date generated, url for URL, result for Resultado. Defaults to: id.
sort
opcional string
Filtrar. Possible values are: desc for Descendente, asc for Ascendente. Defaults to: desc.
per_page
opcional integer
Resultados por página. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Mostrar

API endpoint:

GET 
https://auditoria-digital.pt/api/v1/reports/{id}

Request example: 

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

API endpoint:

POST 
https://auditoria-digital.pt/api/v1/reports

Request example: 

curl --location --request POST 'https://auditoria-digital.pt/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 for Público, 1 for Privado, 2 for Password. Defaults to: 0.
password
opcional string
The password for the report page. Only works with privacy set to 2.
Atualizar

API endpoint:

PUT PATCH 
https://auditoria-digital.pt/api/v1/reports/{id}

Request example: 

curl --location --request PUT 'https://auditoria-digital.pt/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 for Público, 1 for Privado, 2 for 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 for Não, 1 for Sim. Defaults to: 0.
Eliminar

API endpoint:

DELETE 
https://auditoria-digital.pt/api/v1/reports/{id}

Request example: 

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