Introduction. Typographical conventions. Prerequisites. QuickPrints SDK for Windows 8 Version 1.0 August 06, 2014

Size: px

Start display at page:

Download "Introduction. Typographical conventions. Prerequisites. QuickPrints SDK for Windows 8 Version 1.0 August 06, 2014"

Edwin Harvey
6 years ago
Views:

1 Introduction The QuickPrints SDK for Windows 8 provides a set of APIs that can be used to submit a photo print order to a Walgreens store. This document gives step-by-step directions on how to integrate the QuickPrints SDK into a Windows 8 desktop or tablet application. Typographical conventions Classes, methods, variables, field names, and parameter names shall be appear in a fixed-width font Blocks of code will appear in gray boxes with a fixed-width font o Text with a yellow highlight within a block of code are to be replaced with what the text describes; i.e. if affiliate ID is highlighted, then replace that text with an affiliate ID Red colored text should always be read carefully Prerequisites The following items are required in order to use the Walgreens QuickPrints SDK for Windows 8: be utilizing Windows Software Development Kit (SDK) for Windows 8 be developing an application for the United States o QuickPrints is only available via Walgreens, which currently does not have any stores outside of the United States and Puerto Rico have a user account on the Walgreens Developer Portal have an API key have an Affiliate ID have a unique Publisher ID, in order to earn a revenue share commission on photo orders submitted to and sold by Walgreens ensure that all image files to be printed exist in, or be converted to JPEG (.jpg) format prior to being uploaded to Walgreens (or referenced via URL) Instructions on how to get a user account, API key, Affiliate ID, and Publisher ID are listed below. 1

2 Registering with Walgreens To setup a developer account with Walgreens and obtain the API key and Affiliate ID, developers must: create a user account on the Walgreens Developer Portal ( sign into the Walgreens Developer Portal ( select the Set Up an Application button (in the My Page tab) and fill out the form (to request an API key) Once the application has been approved by Walgreens, an automated will be generated and sent to the requester with a link to view the requester's unique API key. The automated will also include a generic test Affiliate ID, extest1. The requester's unique Affiliate ID will be provided to the developer once the requester's application is ready to commence onboard testing with the Walgreens Developer Program team. Registering with Commission Junction Walgreens has partnered with Commission Junction to handle revenue sharing. In order to earn a revenue share commission from photo orders submitted to and sold by Walgreens, a Publisher ID (PID) is required. To obtain a unique Publisher ID: go to click on the Apply link at the top of the page fill out and submit the application form log back in to the portal, once the application has been approved o An automated will be generated and sent to the requester review and accept the Walgreens Photo-Finishing Services Agreement proceed into the "Account" section of the Account Profile to obtain your Website ID (PID) number 2

3 How to use the Quick Prints SDK 1. Add the following files to the project s references Walgreens.QuickPrints.SDK.Windows8.dll 2. Add in references to the QuickPrints SDK using Walgreens.QuickPrints.SDK.Windows8; using Walgreens.QuickPrints.SDK.Windows8.Common.Util; 3. Create an instance of WagCheckoutContext IWalgreensCheckout wagcheckoutcontext = WagCheckoutContext.CreateInstanse(); Note: WagCheckoutContext is the class that provides access to all the key functions in this SDK 4. Initialize WagCheckoutContext using: InitAsync(string affiliateid, string apikey, EnvironmentType environment, string appver, CustomerInfo customerinfo, string publisherid, string prodgroupid) o InitAsync() can return a string If nothing is returned, then initialization has succeeded If a non-empty string is returned, then initialization has failed o AffiliateId, ApiKey and EnvironmentType are mandatory parameters. o customerinfo can be set to null and it is a optional parameter, but passing this information will lead to a better user experience when checking out o publisherid & prodgroupid are provided by Walgreens, but they both can be set to null o appver must be set to the application version o If initialization failed, then InitAsync() must be called again o environment should be set to either: EnvironmentType.Development for staging, or EnvironmentType.Production for production IWalgreensCheckout wagcheckoutcontext = WagCheckoutContext.CreateInstanse(); var cinfo = new CustomerInfo { FirstName= John, LastName= Doe, Phone= , = jdoe@walgreens.com ; string errorcode = await wagcheckoutcontext.initasync( Affiliate ID, API key, EnvironmentType.Development, App Version, cinfo, Publisher ID, ProdGroupId ); if(!string.isnullorempty(errorcode)) { 3

4 MessageBox.Show(errorCode); return; 5. Setup delegates to track the upload and remove statuses // For tracking upload status wagcheckoutcontext.getimageuploadedstatus += GetImageUploadStatus; private void GetImageUploadStatus(object sender, ImageUploadStatus e) { Debug.WriteLine("TotalImageCount - {0 -- Uploaded Images - {1", e.totalimagecount, e.uploadedimagecount); if (e.status == ResultStatus.Completed) { Debug.WriteLine("Process completed"); // For tracking remove status wagcheckoutcontext.getimageremovedstatus += GetImageRemoveStatus; private void GetImageRemoveStatus(object sender, ImageRemoveStatus e) { Debug.WriteLine("TotalImages - {0 -- Removed Images - {1", e.totalimagecount, e.removedimagecount); if (e.status == ResultStatus.Completed) { Debug.WriteLine("Process completed"); 6. The images to be printed must be: uploaded using WagCheckoutContext s UploadImages() method, and/or referenced using WagCheckoutContext s AddImageUrls()method, which will accept URLs of publicly available images Headers for UploadImages() and AddImageUrls(): void UploadImages(List<Picture> pictures); void AddImageUrls(List<string> imageurls); void UploadImage(Stream picture);//stream of picture, captured through phone camera Note: Publicly available image URLs must not require any type of login or authentication The maximum number of images that can be in a single order (regardless of image source) is 100 Images to be printed must be in JPG The images can be removed from the order list To remove local images, use WagCheckoutContext s RemoveImages(), and/or To remove referenced images, use WagCheckoutContext s RemoveImageUrls() To clear all images from the order, use WagCheckoutContext s ClearOrder() Once a landing page URL has been successfully obtained via PostOrderAsync(), the order will 4

5 be cleared automatically Headers for RemoveImages() and RemoveImageUrls() and ClearOrder(): void RemoveImages (List<Picture> pictures); void RemoveImageUrls(List<string> imageurls); void ClearOrder(); 7. (Optional) If needed, the image upload process can be cancelled WagCheckoutContext s CancelUploads() WagCheckoutContext.CancelUploads(); 8. (Optional) If needed, coupon code and/or Affilidate notes can be set by calling SetCouponCode() and SetAffiliateNotes(). But by passing this information will lead to a better user experience when checking out Example code snippet: wagcheckoutcontext.setcouponcode( string coupon ); wagcheckoutcontext.setaffiliatenotes( string AffiliateNotes ); 9. After images have been successfully uploaded and/or image URLs have been added, WagCheckoutContext can be used to: get the maximum size of the order via GetMaxOrderSize() get the list of images in the order via GetImageCount() get the SDK version via GetSdkVersion() // Get the maximum size of the order int maxordersize = WagCheckoutContext.GetMaxOrderSize(); // Get the number of images in the order int imgcount = WagCheckoutContext.GetImageCount(); // To get the version of the SDK string sdkversion = WagCheckoutContext.GetSdkVersion(); 1. After all images have been uploaded, use WagCheckoutContext s PostOrderAsync() to get the landing page URL, which can be loaded into a web container to proceed with the checkout flow. Note: PostOrderAsync() can accept an optional Location object as an input parameter. PostOrderAsync() will return an object with two string properties, CheckoutUrl and Error. If PostOrderAsync() is successful, then Error will be null and CheckoutUrl will have the URL to the landing page. If PostOrderAsync() is unsuccessful, then Error will be contain an error code. 5

6 IWalgreensCheckout wagcheckoutcontext = WagCheckoutContext.CreateInstanse(); var cinfo = new CustomerInfo { FirstName= John, LastName= Doe, Phone= , = jdoe@walgreens.com ; string errorcode = await wagcheckoutcontext.initasync( Affiliate ID, API key, EnvironmentType.Development, App Version, cinfo, Publisher ID, ProdGroupId ); if(!string.isnullorempty(errorcode)) { MessageBox.Show(errorCode); return; // (Optional, not recommended for photos) Disable image compression wagcheckoutcontext.disableimagecompression(bool disablecompression); // For tracking upload status // Note: an example for GetImageUploadStatus is listed in the next code snippet wagcheckoutcontext.getimageuploadedstatus += GetImageUploadStatus; // For tracking remove status // Note: an example for GetImageRemoveStatus is listed in the next code snippet wagcheckoutcontext.getimageremovedstatus += GetImageRemoveStatus; // Upload images // Note: imagestoupload is a List of Pictures wagcheckoutcontext.uploadimages(imagestoupload); // If coupon need to be passed while checkout, pass it as below wagcheckoutcontext.setcouponcode( string coupon ); // If additional notes need to be sent to Walgreens, include the notes with: wagcheckoutcontext.setaffiliatenotes(string affiliatenotes); //////////////////////////////// // Begin the checkout process // //////////////////////////////// // Get the checkout URL that will eventually be loaded in a web container var remotecart = await wagcheckoutcontext.postorderasync(new Location {Latitude = 1.1, Longitude = 8.1 ); if(!string.isnullorempty(remotecart.error) { // Show an error message based on the error code // Load the URL (in remotecart.checkouturl) in a WebBrowser control Example Code Snippet for Delegate Methods: private void GetImageUploadStatus(object sender, ImageUploadStatus e) { Debug.WriteLine("TotalImageCount - {0 -- Uplaoded Images - {1", e.totalimagecount, e.uploadedimagecount); 6

7 if (e.status == ResultStatus.Completed) { Debug.WriteLine("Process completed"); private void GetImageRemoveStatus(object sender, ImageRemoveStatus e) { Debug.WriteLine("TotalImageCount - {0 -- Removed Images - {1", e.totalimagecount, e.removedimagecount); if (e.status == ResultStatus.Completed) { Debug.WriteLine("Process completed"); Example Code Snippet for XAML for WebBrowser: <WebView x:name="webview"/> Example Code Snippets for Code-behind File (XAML.CS) for WebBrowser: //Allow the script notify for WebView from any Uri webview.allowedscriptnotifyuris = WebView.AnyScriptNotifyUri; // Add an event handler for the WebView control s ScriptNotify webview.scriptnotify += webview_scriptnotify; //this message hook needs to be done as html's alert is not supported in WebView void webview_scriptnotify(object sender, NotifyEventArgs e) { string message = e.value; switch (message) { case "checkout_ok_callback": //handle checkout ok callback break; case "checkout_exit_cancel": //handle checkout cancel callback break; case "checkout_exit_back": //handle checkout back callback break; default: //show any other alert message in native MessageDialog var msgdialog = new MessageDialog(message); msgdialog.showasync(); break; 7

8 Setting ScriptNotify hook to the web container: The following messages are called from the HTML5 code in the web container through Notify Script. checkout_ok_callback Call back after the checkout process is complete. checkout_exit_back Call back when the user selects the back button. checkout_exit_cancel Call back when the user cancels the checkout process. 8

9 SDK Related Error Codes & Error Handling Error Code Constant Name Description 901 ERR_CODE_JSON_EXCEPTION Invalid JSON format received from server. 902 ERR_CODE_SIGNATURE_EXCEPTION Error in encrypting API key. Invalid Signature. Please contact Walgreens. 903 ERR_CODE_EXCEED_UPLOAD_IMAGE_COUNT_LIMIT Maximum upload limit count reached. 904 ERR_CODE_ALREADY_INITIALIZED SDK is already initialized. 905 ERR_CODE_NOT_INITIALIZED SDK is not initialized. 906 ERR_INITIALIZATION Problem when initializing the SDK. 907 ERR_CODE_FILE_ALREADY_UPLOADED Image already uploaded to server. 908 ERR_CODE_UPLOAD_CANCELED Upload cancelled. 909 ERR_CODE_UPLOAD_FAILED Upload failed. 910 ERR_CODE_HTTP_CONNECTION Server unavailable. 911 ERR_CODE_EMPTY_CART No file in the cart. 912 ERR_CODE_INVALID_API_KEY Invalid API Key. 913 ERR_CODE_AFFILIATE_ID Invalid Affiliate ID. 914 ERR_CODE_INVALID_ENVIRONMENT Invalid environment argument while initializing SDK. 915 ERR_CODE_INVALID_SEVER_URL Invalid Server URL. 916 ERR_CODE_INVALID_IMAGE Invalid image file/no image available. 917 ERR_CODE_EMPTY_FILE Empty image file. 918 ERR_CODE_ILLEGAL_STATE Illegal SDK state. Upload is already in progress. 919 ERR_CODE_EXCEED_BATCH_IMAGE_COUNT Number of images in a batch exceeded the current limit of ERR_CODE_UNSUPPORTED_IMAGE_FORMAT Unsupported image format. 921 ERR_CODE_NO_FILES_TO_UPLOAD There is no file to upload. All images have been uploaded already. 922 ERR_CODE_START_UPLOAD_SERVICE Problem starting the background image upload service. 923 ERR_CODE_NULL_ANDROID_CONTEXT Android Context is null. It must be 9

10 valid android context. 924 ERR_CODE_NETWORK_UNAVAILABLE SDK unable to connect to the Internet/network due to a weak or unavailable signal. 925 ERR_CODE_INVALID_IMAGE_URL Invalid remote image URL. 926 ERR_CODE_GENERAL_EXCEPTION General Exception HTML5 Related Error Codes & Error Handling Error Code Constant Name 652 STORE_NOTAVAILABLE No stores found. 654 PRICE_PRODUCT_MISSING Product price is missing. 655 PRICE_EXCEPTION Exception in price. 656 COUPON_MISSING Coupon is missing. 657 COUPON_EXCEPTION Exception in coupon. 658 DEVICEINFO_MISSING Device info missed. Description 1000 COUPON_INVALID Coupon invalid. Please enter a valid coupon CART_EXPIRED Cart (Session) has expired. Please try again SERVICE_UNAVAILABLE The service is temporarily unavailable. Please try again later AFFILIATE_NOTEXIST Invalid affiliate INVALID_SIGNATURE Invalid signature NOT_AUTHORIZED Not authorized INVALID_QUANTITY Invalid quantity. Please enter a valid quantity INVALID_PRICE Invalid price. 10

Introduction. Typographical conventions. Prerequisites. QuickPrints SDK for Windows Phone 8 Version 1.0 November 20, 2013

Introduction. Typographical conventions. Prerequisites. QuickPrints SDK for Windows Phone 8 Version 1.0 November 20, 2013 Introduction The provides a set of APIs that can be used to submit a photo print order to a Walgreens store. This document gives step-by-step directions on how to integrate the QuickPrints SDK into a Windows