Rapporten

Notities
Expert level
De API-sleutel moet als Bearer-token worden verzonden in de autorisatiekop van het verzoek. Haal je API-sleutel op.
Lijst

API-eindpunt:

GET 
https://audit.webarctic.nl/api/v1/reports

Voorbeeldverzoek: 

curl --location --request GET 'https://audit.webarctic.nl/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Omschrijving
search
optioneel string
De zoekopdracht.
search_by
optioneel string
Zoeken op. Mogelijke waarden zijn: url voor URL. Standaardinstelling: url.
project
optioneel string
De projectnaam.
result
optioneel string
The report result. Mogelijke waarden zijn: good voor Goed, decent voor Fatsoenlijk, bad voor Slecht.
sort_by
optioneel string
Sorteren op. Mogelijke waarden zijn: id voor Datum aangemaakt, generated_at voor Datum gegenereerd, url voor URL, result voor Resultaat. Standaardinstelling: id.
sort
optioneel string
Sorteren. Mogelijke waarden zijn: desc voor Aflopend, asc voor Oplopend. Standaardinstelling: desc.
per_page
optioneel integer
Resultaten per pagina. Mogelijke waarden zijn: 10, 25, 50, 100. Standaardinstelling: 50.
Tonen

API-eindpunt:

GET 
https://audit.webarctic.nl/api/v1/reports/{id}

Voorbeeldverzoek: 

curl --location --request GET 'https://audit.webarctic.nl/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Winkel

API-eindpunt:

POST 
https://audit.webarctic.nl/api/v1/reports

Voorbeeldverzoek: 

curl --location --request POST 'https://audit.webarctic.nl/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Omschrijving
url
verplicht string
The webpage's URL.
privacy
optioneel integer
Report page privacy. Mogelijke waarden zijn: 0 voor Openbaar, 1 voor Privé, 2 voor Wachtwoord. Standaardinstelling: 0.
password
optioneel string
The password for the report page. Only works with privacy set to 2.
Bijwerken

API-eindpunt:

PUT PATCH 
https://audit.webarctic.nl/api/v1/reports/{id}

Voorbeeldverzoek: 

curl --location --request PUT 'https://audit.webarctic.nl/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Omschrijving
privacy
optioneel integer
Report page privacy. Mogelijke waarden zijn: 0 voor Openbaar, 1 voor Privé, 2 voor Wachtwoord.
password
optioneel string
The password for the report page. Only works with privacy set to 2.
results
optioneel integer
Update the report results. Mogelijke waarden zijn: 0 voor Nee, 1 voor Ja. Standaardinstelling: 0.
Verwijderen

API-eindpunt:

DELETE 
https://audit.webarctic.nl/api/v1/reports/{id}

Voorbeeldverzoek: 

curl --location --request DELETE 'https://audit.webarctic.nl/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'