API
We would like to hear your input for improvements. Please send this to NOBB-VAVVS.
E-post: supportvavvs@byggtjeneste.no
Endpoints
The test solutions are restored with data from PROD night to Monday
Test solution | Production solution |
---|---|
Swagger
In Swagger, you will find an overview of available versions of the API and further details about what functions are in these.
NOTE! Always use the latest version of the API. Older versions of the API may eventually be discontinued, but this will be notified on an ongoing basis.
Swagger has been added to the following addresses:
Test solution | Production solution |
---|---|
NOTE! Log in with your API user to access the swagger pages on the pages first.
Catalogue definitions
Here you will find lists of all fields, lookup lists and rules that are in the databases:
NOTE! Log in with a user who has API access and enter the following addresses in the browser:
https://nobb-vavvs.no/API/1.1/Produktdata/HentFeltlisteXlsx
Permanent links to product files
An example of such a link is:
https://nobb-vavvs.no/produkt/5507483/produktbilde
The system follows the following template: /produkt/<produktnr>/<feltnavn for nedlasting>
Examples:
Type | Lenke |
---|---|
Main picture | /produkt/<produktnr>/produktbilde |
FDV | /produkt/<produktnr>/fdv-dokumentasjon |
Produktblad | /produkt/<produktnr>/produktblad |
See the catalogue definition to find field names for all downloads contained in the solution.
Authentication
Authentication is done for the time being with BASIC authentication. Security and encryption here are taken care of by the transport layer (HTTPS).
Example:
Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l
More information here: https://en.wikipedia.org/wiki/Basic_access_authentication
NOTE! NOBB-VAVVS creates API users who are given special access to the system with which you must log in.
Error codes
In the event of a validation error in the API, HTTP result code 422 is returned, with the following JSON structure:
Example:
{
"Error" : "beskrivende feilmelding her",
"Code" : 123
}
Error - Feilmelding
Code - Feilmeldingskode
Throttling
All API users are encouraged to run at night between 02:00 and 06:00 (Norwegian time). The throttling will then have a less restrictive setup.
NOTE! In case of error code 429 - then the API calls must wait and run again. See further information in the headers.
Endpoints with throttling transmitter with headers with info about this:
x-rate-limit-limit: 1sx-rate-limit-remaining: 4x-rate-limit-reset: 2020-06-08T13:58:10.7711830Z
If the API throttles then sent with header:
retry-after: 1