National BIM Library API - guide

What is it

We have released an API which allows partner organisations* to insert a list if of all systems and products making up the new UniClass content structure used in NBS Create, into their website or software (a bit like MyNBSPlus.co.uk).

*Partner organisations = RIBA, RICS, BuildingSMART etc

What does it look like

An example system outline definition 60-45-40/140 Solar Heating System) and a product definition is shown in the screenshot of 90-10-70/340 Canned rotor pumps below:

                                     

Licensing

Although the area is not restricted a licence key needs to be coded into the site to setup the synchronisation.

Licensing requirements

  • Each customer must have registered for an account on theNBS.com (so that they accept our T&C’s).
  • Each enquiry must be accompanied by a short submission (no more than one side of A4) detailing what they intend to use the API for.
  • The enquiry and submission should be referred to Stephen Hamil and Richard Watson who will make a call on whether we should be providing licences.

Licensing Process

  • Reply to the customer’s enquiry asking them to fulfil the requirements details above.  There is an email template on the X:\drive to help with this.
  • X:\CustomerCentre\SoftwareSupport\SS External\Email Drafts\Current
  • National BIM Library API enquiry.oft
  • The company must be entered into Pivotal, and a support incident logged against Product = NBS Create with knowledgebase Compatibility > National BIM Library > National BIM Library API enquiry to record where licences have been issued).
  • The customer’s details are added to the Licence spreadsheet against the next available licence.

The licence codes are available herehttp://ribae/CustomerCentre/Internal%20Resources/Forms/AllItems.aspx


More information

Information for customers on http://www.thenbs.com/support/nbl/index.asp

API Page http://www.nationalbimlibrary.com/API/

Guidance for users

The guidance we have is in the form of a sample application written by Andy Fowler. It is available here: http://www.thenbs.com/support/nbl/index.asp :


We hope this will help them as a starter for 10. The services also have auto-generated help pages e.g. http://api.nationalbimlibrary.com/entity/help.

Any further queries programming related issue: Phil Withington, more general enquiries would be best handled by Hammy.