Skip to content

Home

Jump to bottom
Tim Hall edited this page Mar 16, 2014 · 18 revisions

Getting Started

  1. In a new or existing workbook, open VBA (Alt+F11) and import all files from the src/ directory into the workbook (RestClientBase.bas is optional)
  2. Add a reference to Microsoft Scripting Runtime: VBA Window > Tools > References > Select Microsoft Scripting Runtime
  3. In a new module or class, create a new RestClient for the service, create a new RestRequest to request something specific from the service, and then use the client to execute the request (See below for a simple example)
  4. That's it! There are many advanced uses for Excel-REST, including asynchronous requests so that Excel isn't locked up, Authenticators for accessing services with Basic, OAuth1, and OAuth2 authentication, and detailed requests for complex APIs.

Components

  • RestRequest Create a rich definition of the request, including Resource (URL), Method (GET, POST, etc), Format (json), Headers, Querystring, Body, and more.
  • RestClient Execute RestRequests, both sync and async.
  • RestResponse Formatted response from RestRequest, including status (200, 404, etc), content, and parsed results.

Examples

See the examples/ folder to see these examples in action

Additional topics

Clone this wiki locally