Support center

Har du et spørgsmål om BIM Shark? Du er det rette sted!

API v1 dokumentation

Indhold

  • Kom igang
  • Autorisation
  • Eksempel
  • Oversigt

Kom igang

Bimsharks API kan benyttes af udviklere til at hente og redigere information om byggebeskrivelser tilknyttet en brugerkonto.
For at bruge API’en kræver det altså, at man har en brugerkonto. Ved kontakt til APIen skal man desuden bruge sin API-nøgle, som man finder under konto-oplysningerne, når man er logget ind.
(Klik på dit brugernavn i øverste højre hjørne -> Redigér din konto -> Vælg fanen API)
API-nøglen er unik for hver enkelt bruger.

Autorisation

Når der foretages et API kald skal den personlige API nøgle samtidig medsendes, for at autorisere forespørgslen.
API nøglen sendes med som en custom header bimshark-api-key.
Eksempel:

$ curl -H "bimshark-api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx" https://app.bimshark.com/api/v1/projects

API’en returner JSON-data ved succes eller statuskode 404 + fejlbesked, hvis API nøglen ikke kunne genkendes.

Eksempel

Hvis du ønsker at hente informationer ud om alle dokumenter for en bruger, kan du kalde følgende url.

https://app.bimshark.com/api/v1/documents

HTTP kaldet kunne så se således ud:

$ curl -H "bimshark-api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx" https://app.bimshark.com/api/v1/documents

Ovenstående vil returnere:

[{"id":45,"title":"Byggebeskrivelse","document_id":81,"user_id":6,"company_id":1,"project_id":2,"published_by":6,"uniq_url":"http:\/\/localhost\/bimshark\/bimshark-2\/public\/pubdocs\/view\/45ffa2bd12","created_at":"2014-04-11 15:14:25","updated_at":"2014-04-11 15:14:25","header":"","footer_left":"","footer_right":"","deleted_at":null,"tag_document":"#marts,#vinduer","tag_paragraph":"#loftsvindue,#kældervindue"}

API-kald

Herunder er en oversigt over tilgængelige api-kald.
For at isolere informationer til et enkelt element, skrives ID’et blot efter en skråstreg – f.eks. vil /projects/32 returnere informationer om dette enkelte projekt.

Metode URL Beskrivelse
GET https://app.bimshark.com/api/v1/documents Returnerer liste over dokumenter fra alle brugerens projekter
GET https://app.bimshark.com/api/v1/documents/[document_id] Isoleret information om dokument
GET https://app.bimshark.com/api/v1/documents/[document_id]/paragraphs Returnerer liste over afsnit fra dokument
GET https://app.bimshark.com/api/v1/paragraphs/[paragraph_id] Returnerer isoleret information om afsnit
GET https://app.bimshark.com/api/v1/projects Liste over projekter
GET https://app.bimshark.com/api/v1/projects/[project_id] Isoleret information om projekt
GET https://app.bimshark.com/api/v1/projects/[project_id]/documents Returnerer liste over dokumenter for projekt
GET https://app.bimshark.com/api/v1/projects/[project_id]/components Returnerer bygningsdele for projekt
POST https://app.bimshark.com/api/v1/sheet Tilføje skema med en variabel mængde Sharktags.
Tilgængelige felter: ‘name’, ‘revit_id’, ‘project_id’, ‘json_array’.
Er der allerede et skema i projektet med samme revit_id, overskrives dette.
POST https://app.bimshark.com/api/v1/quantities Opdaterer mængder for bygningsdele.
Tilgængelige felter: ‘project_id’, ‘json_array’.
POST https://app.bimshark.com/api/v1/projects/[project_id]/component Indsæt en ny bygningsdel i et projekt.
Tilgængelige felter: ‘name’, ‘structure’, ‘classificationcode’, ‘discipline_id’, ‘measure_id’, ‘active’ (1 eller 0), ‘description’.
Den oprettede bygningsdel vil blive returneret som JSON inkl. bygningsdel ID.

 

Seneste opdateret 13 marts 2018 af msb@bimshark.com

Populære artikler