Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
api_documentation_examples [2014/04/03 17:16]
ybarajas
api_documentation_examples [2014/06/18 17:23] (current)
ybarajas
Line 1: Line 1:
 +======Examples======
 +
 +These sample codes are available on GitHub to help explain how our APIs work. ((iPass will not provide support for any of these samples.))
 +
 +**Log In & Obtain Key-** This example shows how to authenticate with the Open Mobile Portal API server and obtain the key for subsequent API calls.
 +^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​java/​com/​ipass/​api/​sample/​core/​Login.java|Java]] ^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​sh/​core/​Login.sh|cURL]] ^
 +
 +
 +----
 +
 +**Monthly CDR-** This example shows how to download Monthly CDRs and Adjusted Monthly CDRs. 
 +^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​java/​com/​ipass/​api/​sample/​billingreport/​MonthlyCDR.java|Java]] ^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​sh/​billingreport/​MonthlyCDR.sh|cURL]] ^  ​
 +
 +----
 +
 +**Daily CDR-** This example shows how to download Daily CDRs and Adjusted Daily CDRs. 
 +^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​java/​com/​ipass/​api/​sample/​billingreport/​DailyCDR.java|Java]] ^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​sh/​billingreport/​DailyCDR.sh|cURL]] ^ 
 +
 +----
 +
 +**Network & Client Users-** This example shows how to download the Network & Client Users report in two different formats: the CSV format, which is typical for importing to Excel Spreadsheet,​ and the XML format (also includes useful billing information such as Network Counts, Software Counts and etc.) 
 +^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​java/​com/​ipass/​api/​sample/​billingreport/​NetworkAndClientUsers.java|Java]] ^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​sh/​billingreport/​NetworkAndClientUsers.sh|cURL]] ^ 
 +
 +----
 +
 +**Child Companies-** This example shows how to download a list of all child company IDs and names.
 +^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​java/​com/​ipass/​api/​sample/​core/​ChildCompanies.java|Java]] ^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​sh/​core/​ChildCompanies.sh|cURL]] ^  ​
 +
 +----
 +
 +**Custom Reports-** This example demonstrates how to download one of the Custom Reports -  //​ClientUserVersion report//. The downloaded file will be in a zip format, which contains the reports for ALL the child companies.
 +
 +^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​java/​com/​ipass/​api/​sample/​report/​Custom.java|Java]] ^ [[https://​github.com/​iPass-Portal/​Sample-API/​blob/​master/​src/​sh/​report/​Custom.sh|cURL]] ^ 
 + 
 +
 +----
 +
 +Go to: **[[:​start|Portal Home]]** > **[[:​api_documentation|REST API Overview]]**
  
 

©2015 iPass Inc. All rights reserved. Terms of Use