Implementation Guide

This is a step by step implementation guide explaining how to consume network services directly from Sprint in both sandbox and production environments. read more.

Sprint Services Framework Forum

If you can't find the answers to your questions about our sandbox or the full Sprint Services Framework, please post your question in our forum. read more.

API Dev Guides

This is the heart of the Framework. These guides provide information on service call requirements from authentication to input and output parameters. There are also example calls for additional clarity.

Introduction

Welcome to Sprint Services Framework ("SSF"). All of our services are REST based and the documentation below should provide you the necessary service definitions for consuming the services in your applications. The services are designed in such a way that they can be consumed on a mobile device, a desktop or an embedded device. Please note that the service definitions are the same for both Sandbox and Production accounts, with the only change being the account credentials (key & secret). Please make sure you review the authentication section on this page before you start your development in order to understand how to implement the key and the secret within your code. As a general rule, you should never expose your key or secret to the users of your application, at least not without proper authentication, as you should be aware this grants them access to the Sprint Services Framework via your account. If your client application does not include any authentication (such as a social networking type app where access is not so restrictive), we suggest you to initiate your service calls on the server-side keeping the key\secret hidden utilizing proper session management. We also suggest you keep your key/secret in a secured configuration file so that, when moving to the production platform, you can easily modify your credentials. Also, please check out our emulator and the sample code pages for a quick start.

Device User's or Account Holder's Consent

To protect the privacy of our customers, Sprint Services Framework APIs (Location, SMS & MMS) require the consent from the device user or the device account holder. The consent is stored in our system for future verifications and applicable to all further service calls. The device user or the account holder has an option of changing the consent at anytime. Each developer requires only one consent for all the Sprint Services Framework APIs.

Step1: Send an invite to the device user or the account holder:

• Use device API to add a device. Upon successful completion of the call, the service sends a SMS message to the device with a link to take action by the device user and and provide the consent decision.
• Alternatively, our pre-built Sandbox Account Management or Production Account Management section can also be used for a quick way to add a device manually. Please note that you must be an approved user to view the Sandbox Account Management section and you must be an approved paid user to view the Production Account Management section. If you are not an approved SSF user, please complete the signup form to get access to SSF.

Step2: The device user or account holder takes action:

• The device user should click on the link in SMS message to complete the action. The link in SMS message uniquely identifies the consent request and provides an option either to accept or decline the consent request. If the device is not capable of receiving SMS messages, the device user or account holder can go to SSF Consent management system and use sprint.com login credentials to provide the consent. Please note that the developer must invite before the device user provides his consent.

Step3: Consent response captured:

• The device user's or Account holder's consent response is stored in the system for future service call consent verifications. The device user or account holder can go to SSF Consent management system and use sprint.com login credentials to change the consent at anytime.

API Pricing Matrix and Cost:

On Sandbox, you will be provided with 500 credits per day and you can add up to five devices. The cost of each service is shown below. In Production, you will be charged for each service call as per the pricing matrix below and allows you to utilize the services for unlimited devices (Phones, Datacards or other M2M devices) and unlimited service calls until your credit balance is positive.

*LBS precision fix charges apply

Authentication

All of our services except iDEN content uploader follows a generated MD5 Signature.

• This is a MD5 digest of the parameters sorted in alphabetical order appended with the shared secret.
• For more information on generating a digital signature in your applications read the Authentication page.

iDEN content uploader follows token based authentication. Token based authentication is simply passing the developer's key along with the request. Secret is not being used here.