|
Introduction
GSMUnlockUSA API allows your applications to communicate directly with the GSMUnlockUSA server. You can now order unlock codes, check if an order has been delivered, verify orders, and much more, directly from your own website, without having to log in on GSMUnlockUSA.
The API is XML-based, platform-independent, and can be integrated on any OS in any programming language.
The API url is: http://api.GSMUnlockUSA.com/unlockservice.asmx
Setting up
You need to register an account on GSMUnlockUSA. Once you are done you need to load some credits to your account. You need to have minimum 1 credit to be able to use the GSMUnlockUSA API.
Then contact admin@gsmunlockusa.com and ask to activate API for your account on GSMUnlockUSA. We need your registered email. Now you will receive your own API KEY.
If you need assistance with the API, please feel free to contact admin@gsmunlockusa.com. We will do our best to quickly reply your requests and help you integrate the API efficiently into your application.
Thank you for using GSMUnlockUSA.
|
 GSMUnlockUSA_API |
 PHP Sample |
|
|
ASP.NET(C#) Sample |
Available functions
In the GSMUnlockUSA API, the services are named Function.
Each “Function” allows your application to perform a specific task: load a list of unlocking service, place an order, get an order, etc.
Here is an exhaustive list of the actions:
|
Service Functions |
Description |
|
GetAccountInfo |
Returns information on the GSMUnlockUSA account associated with the current API key |
|
GetService |
Returns a list of supported unlocking service |
|
GetServiceCountry |
Returns a list of countries supported by a particular unlocking service |
|
GetServiceNetwork |
Returns a list of networks supported by a particular unlocking service |
|
GetServiceBrand |
Returns a list of brands supported by a particular unlocking service |
|
GetServiceModel |
Returns a list of models supported by a particular unlocking service |
|
GetMEP |
Returns a list of MEP Name |
|
PlaceOrder |
Order an unlock code |
|
VerifyOrder |
Verify an unlock code delivered |
|
GetOrder |
Returns an unlock codes ordered |
The following pages detail these service functions.
GetAccountInfo
a. Description
Returns information on the GSMUnlockUSA account associated with the current API key.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<Balance>
<Credits>0.00</Credits>
<CreditLimit>0.00</CreditLimit>
</Balance>
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
Credits |
Credits currently available on the account |
Always |
Digits |
|
CreditLimit |
Credits limit currently available on the account |
Always |
Digits |
GetService
a. Description
Returns a list of supported unlocking service.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<Service>
<ID>290</ID>
<Name>AT&T/Cingular Instant Blackberry</Name>
<Credit>1.99</Credit>
<ProcessTime>1-10min</ProcessTime>
<IsMEP>True</IsMEP>
<IsNetwork>True</IsNetwork>
<IsModel>True</IsModel>
<IsPIN>False</IsPIN>
<IsRMType>False</IsRMType>
<IsKBH>False</IsKBH>
<IsReference>False</IsReference>
<IsServiceTag>False</IsServiceTag>
<IsCDMA>False</IsCDMA>
<PriceGroupID>5</PriceGroupID>
<PriceGroupName>AT&T/Cingular Network</PriceGroupName>
</Service>
…
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
ID |
Service ID |
Always |
Digits |
|
Name |
Service name |
Always |
String |
|
Credit |
Cost of an unlock code on this tool, in credits |
Always |
Digits |
|
ProcessTime |
Process time |
Always |
String |
|
IsMEP |
Whether or not the service needs the MEP Name |
Always |
Boolean |
|
IsNetwork |
Whether or not the service needs the network |
Always |
Boolean |
|
IsModel |
Whether or not the service needs the model |
Always |
Boolean |
|
IsPIN |
Whether or not the service needs the Pin number |
Always |
Boolean |
|
IsRMType |
Whether or not the service needs the RM Type |
Always |
Boolean |
|
IsKBH |
Whether or not the service needs the KBH/KRH |
Always |
Boolean |
|
IsReference |
Whether or not the service needs the Reference |
Always |
Boolean |
|
IsServiceTag |
Whether or not the service needs the Service Tag |
Always |
Boolean |
|
IsCDMA |
Whether or not the service needs the MEID/ESN |
Always |
Boolean |
|
PriceGroupID |
Group ID |
Always |
Digits |
|
PriceGroupName |
Group name |
Always |
String |
GetServiceCountry
a. Description
Returns a list of countries supported by a particular unlocking service.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
|
vServiceID |
Unlocking Service ID |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<ServiceCountry>
<ID>226</ID>
<Name>United States</Name>
</ServiceCountry>
…
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
ID |
Country ID |
Always |
Digits |
|
Name |
Country name |
Always |
String |
GetServiceNetwork
a. Description
Returns a list of networks supported by a particular unlocking service.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
|
vServiceID |
Unlocking Service ID |
Yes |
String |
|
vCountryID |
Country ID |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<ServiceNetwork>
<ID>1905</ID>
<Name>Airadigm Communications</Name>
</ServiceNetwork>
…
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
ID |
Network ID |
Always |
Digits |
|
Name |
Network name |
Always |
String |
GetServiceBrand
a. Description
Returns a list of brands supported by a particular unlocking service.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
|
vServiceID |
Unlocking Service ID |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<ServiceBrand>
<ID>211</ID>
<Name>Toshiba</Name>
</ServiceBrand>
…
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
ID |
Brand ID |
Always |
Digits |
|
Name |
Brand name |
Always |
String |
GetServiceModel
a. Description
Returns a list of models supported by a particular unlocking service.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
|
vServiceID |
Unlocking Service ID |
Yes |
String |
|
vBrandID |
Brand ID |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<ServiceModel>
<ID>5893</ID>
<Name>Toshiba 903T</Name>
</ServiceModel>
…
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
ID |
Model ID |
Always |
String |
|
Name |
Model name |
Always |
String |
GetMEP
a. Description
Returns a list of MEP Name.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<MEP>
<ID>1</ID>
<Name>MEP-04103-001</Name>
</MEP>
…
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
ID |
MEP ID |
Always |
Digits |
|
Name |
MEP name |
Always |
String |
PlaceOrder
a. Description
Order an unlock code.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
|
vServiceID |
Unlocking Service ID |
Yes |
String |
|
vIMEI |
Mobile phone IMEI number |
Yes |
String |
|
vNetworkID |
ID of the mobile network |
No |
String |
|
vModelID |
Mobile phone ID |
No |
String |
|
vMEPID |
MEP number of the phone |
No |
String |
|
vPINNumber |
PIN of the phone |
No |
String |
|
vProviderID |
Provider ID of the phone |
No |
String |
|
vPRD |
PRD Name |
No |
String |
|
vSN |
Serial Number |
No |
String |
|
vRMType |
Type of the phone |
No |
String |
|
vKBHKRH |
KBH number of the phone |
No |
String |
|
vReference |
Reference of the phone |
No |
String |
|
vServiceTag |
Service Tag of the phone |
No |
String |
|
vNotes |
Additional notes |
No |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<Result>
<OrderID>1234567890</OrderID>
<UnlockCode>0000000000</UnlockCode>
<Message></Message>
<Error></Error>
</Result>
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
OrderID |
Order ID |
Always |
Digits |
|
UnlockCode |
Unlock code |
Always |
String |
|
Message |
Addittional message |
Always |
String |
|
Error |
Error message |
Always |
String |
VerifyOrder
a. Description
Verify an unlock code delivered.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
|
vAPIOrderID |
Order ID |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<Result>
<OrderID>1234567890</OrderID>
<UnlockCode></UnlockCode>
<Message>VERIFYING</Message>
<Error></Error>
</Result>
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
OrderID |
Order ID |
Always |
Digits |
|
UnlockCode |
Unlock code |
Always |
String |
|
Message |
Addittional message |
Always |
String |
|
Error |
Error message |
Always |
String |
GetOrder
a. Description
Returns an unlock codes ordered.
b. Parameters
|
Field |
Description |
Required |
Type |
|
vAPIKey |
Your api key |
Yes |
String |
|
vAPIOrderID |
Order ID |
Yes |
String |
c. XML Stream format
This is an example. Real data will be different.
<?xml version='1.0' encoding='utf-8' ?>
<API>
<Result>
<OrderID>1234567890</OrderID>
<UnlockCode>NOT FOUND</UnlockCode>
<Message></Message>
<Error></Error>
</Result>
</API>
d. Field descriptions
|
Field |
Description |
Visibility |
Type |
|
OrderID |
Order ID |
Always |
Digits |
|
UnlockCode |
Unlock code |
Always |
String |
|
Message |
Addittional message |
Always |
String |
|
Error |
Error message |
Always |
String |
Technical support
We hope you now have a good understanding of the GSMUnlockUSA API. We are at your full disposal for any question, or suggestion, about it.
If you need assistance with the API, please feel free to contact admin@gsmunlockusa.com . We will do our best to quickly reply your requests and help you integrate the API efficiently into your application.
Thank you for using GSMUnlockUSA.
