BuildAPIAccess

An objective-c macOS/tvOS/iOS library for impCentral API access

Latest Release: 3.3.0

 

About BuildAPIAccess

BuildAPIAccess is an Objective-C (macOS, iOS and tvOS) wrapper for Electric Imp’s impCentral™ API. It is called BuildAPIAccess for historical reasons: it was written to the support Electric Imp’s Build API, the predecessor to the impCentral API.

BuildAPIAccess requires the (included) classes Connexion, Token and LogStreamEvent. All three are convenience classes for combining properties.

  • Connexion combines an NSURLSession instance and associated impCentral API connection data.
  • Token is used to store impCentral API authorization data.
  • LogStreamEvent is a packaging object for Server-Sent Events (SSE) issued by the impCentral API’s logging system.

API Usage and Methods

Please see the Read Me on GitHub for a full API listing.

HTTP User Agent

From version 2.0.1, BuildAPIAccess issues HTTPS requests with a custom user agent string of the following form:

BuildAPIAccess/<VERSION> <HOST_APP_NAME>/<VERSION> (macOS <VERSION>)

impCentral API Authorization

Making use of the impCentral API requires an Electric Imp account. You will need your account username and password to authorize calls to the API. These are passed into the login: method. BuildAPIAccess instances do not maintain a permanent record of the selected account; this is the task of the host application.


Release Notes

  • 3.3.0 6 September 2019
    • Add support for impCental user-defined environment variables: you can now pass the key env_vars into the method updateDeviceGroup:::’s values array.
  • 3.2.0 1 May 2019
    • Add support for impCental (Test) DUT device groups.
  • 3.1.1 29 November 2018
    • Add support for Electric Imp’s alpha library checking endpoint.
  • 3.1.0 24 August 2018
    • Finalize multi-password authentication (MPA) support.
      • Remove is2FA parameter from login::: (it’s redundant).
    • Issue notification on login rejection rather than post an error.
    • Unify all non-code error notifications (@"BuildAPIError") to return { "message": <error_message>, "code": <error_code> }
  • 3.0.1 10 July 2018
    • Add getAccount and gotMyAccount methods.
  • 3.0.0
    • Major revision to support Electric Imp’s impCentral API.
    • End support for the Build API, now deprecated by Electric Imp.
  • 2.0.1
    • Add methods: clearAPIKey:, setAPIKey:.
    • Add numberOfConnections property.
    • Add custom User-Agent string to all HTTP requests.
    • Add BuildAPIAccess version constant.
    • Minor Bug fixes.
  • 2.0.0
    • Major code revision and extended API support.
  • 1.1.1—1.1.3
    • Minor Bug fixes.
  • 1.1.0
    • Initial public release.

Source Code

You can view BuildAPIAccess’s source code at GitHub.


Related Software


The Seal of RassilonThe Seal of Rassilon
Site and software copyright © 2020, Tony Smith
Site Last Updated: 23 October 2020