Remote API V1.1 Documentation

Transcription

1 Remote API V1.1 Documentation

2 Disclaimer: This manual is licensed under Cellunlocker.net. The information contained in these materials is proprietary and confidential to Cellunlocker.net and/or its subsidiaries or affiliates and is provided for the sole use of the individual or entity to whom it is addressed. These materials must be kept in the strictest confidence. These materials may contain third-party copyright and/or trademark materials, the use of which has not always been specifically authorized by the intellectual property owner. All copyrights and/or trademarks contained in these materials are the sole and exclusive property of their respective owners. Information in this document is subject to change without notice. No portion of these materials may be reprinted, republished, modified, reproduced, sold, disseminated, disclosed or distributed in any form to any other party without the express written consent of Cellunlocker.net. Copyright 2017 Cellunlocker.net. All rights reserved.

3 Table of Contents 1.0 INTRODUCTION Change Log SETUP Programming Language Prerequisites API Key Parsing JSON Basic Authentication and Submitting Requests POST Requests COMMANDS Accounts Get Account Information Tools Get Unlock Tools Get Specific Unlock Tool Orders Get Order History Get Order By Order ID Get Pending Orders Search Order By IMEI Or Order ID Submit Order Instructions Get Instructions Get Specific Instructions Error Responses Error Response Format API Class Prerequisites Setup Commands Get Account Information Get Tools Get Specific Tool Get Order History Get Order By Order ID Get Pending Orders Search Order Submit Order Get Instructions...24

4 1.0 INTRODUCTION Cellunlocker.net API allows resellers to connect and perform website transactions without visiting the Cellunlocker.net website. It can be seamlessly integrated allowing resellers to submit orders through their own websites, segregating reseller customers and Cellunlocker.net. Cellunlocker.net provides the quickest turnaround times with great support from our staff, ensuring resellers will also provide the best service to their customers. 1.1 Change Log Date Version Description First release No longer using basic authentication 1 / 24

5 2.0 SETUP 2.1 Programming Language This document is written with references and examples using PHP programming language. PHP is not a requirement for this API and this document will be easy to follow without having experience in PHP. As long as your environment can execute HTTP requests, equivalent procedures can be executed. 2.2 Prerequisites API Key You will need an API key associated with your account. Enter Cellunlocker.net website with your credentials and hover the Remote API tab at the bottom of the menu bar. Select API Key and click on [Generate New API Key] button to generate an API key for your account Parsing JSON All responses from the API server will be in JSON format. PHP has native support parsing JSON strings, please refer to your environment's manual regarding JSON support. 2 / 24

6 2.3 Basic Authentication and Submitting Requests To authenticate with the API server, enter your API key as a URL parameter in the url variable, please check the example below. The password can be ignored or entered as x. The following below is an example of using the curl extension. In curl, the username and password is entered as one string separated by a colon. $apikey = xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx ; $url = $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); // other curl options entered here... // get data in response variable $response = json_decode(curl_exec($ch),true); curl_close($ch); : 200 OK { "name":"company Name", "credits":"0.00", "tier":# } Data will be stored as an array after the JSON data has been parsed. 3 / 24

7 2.3.1 POST Requests All request types not GET are required to submit data in JSON format. Below is an example of submitting a POST request in curl. if($requestmethod == 'POST'){ $json = json_encode($data); } curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, $json); curl_setopt($ch, CURLOPT_HTTPHEADER, array( ); 'Content-Type: application/json', 'Content-Length: '. strlen($json)) 4 / 24

8 3.0 COMMANDS 3.1 Accounts Get Account Information GET name Company Name credits 0.00 tier Tier # 5 / 24

9 3.2 Tools Get Unlock Tools Get list of tools available for your account. GET array: toolid toolname description Tool ID sorttype reqimei reqmake reqmodel reqmep reqpin reqserial reqnetwork reqservicetag reqkbh reqtype reqother reqprovider reqprd supportedmakes hasaddparams (?) Tool Name Description Carrier / Manufacturer / Software Array of supported makes (?) In some tools, additional information is required. Please use "get specific tool" API call to verify. Please check all req(name) to see what is required and use the data (if provided) in get specific tool call when submitting an order. 6 / 24

10 3.2.2 Get Specific Unlock Tool Get a specific unlock tool available for your account. GET toolid Tool ID toolname Tool Name description Description sorttype Carrier / Manufacturer / Software reqimei reqmake reqmodel reqmep reqpin reqserial reqnetwork reqservicetag reqkbh reqtype reqother reqprovider reqprd supportedmakes Array of supported makes addparams (?) Additional parameters if required for tool (?) In some tools, additional information is required. Please check all req(name) to see what is required and use the data (if provided) in addparams when submitting an order. 7 / 24

11 3.3 Orders Get Order History Get completed order history in descending order. GET orderid Order ID imei IMEI unlockcode Unlock Code make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered datecompleted Date Completed 8 / 24

12 3.3.2 Get Order By Order ID Get order by order id. If it does not exist, an error is returned. GET pendingorders: orderid Order ID imei IMEI make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered completedorders: orderid Order ID imei IMEI unlockcode Unlock Code make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered datecompleted Date Completed Error Response code 404 message No pending or completed orders found with order ID: xxxxxxxx 9 / 24

13 3.3.3 Get Pending Orders GET numorders Number of Orders orders: orderid Order ID imei IMEI make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered Error Response code 404 message You have no pending orders 10 / 24

14 3.3.4 Search Order By IMEI Or Order ID GET { imei=# or orderid=# } numorders Number of Orders orders: orderid Order ID imei IMEI unlockcode Unlock Code make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered datecompleted Date Completed Error Response imei: code 404 message Could not find an order with imei: xxxxxx order id: code 404 message Could not find an order with id: xxxxxx 11 / 24

15 3.3.5 Submit Order POST Input Fields Type Description imeis (*) array An array containing imei(s) for your order toolid (*) int Tool ID for order notes string Notes regarding your order opt string Results will be sent to this params (?) array Additional parameters (make, model, network, mep, etc) Example: (*) Required fields (?) Additional parameters are required for some tools. Please use get specific tool API call to verify. Below is an example of including extra parameters. $order['imeis'] = array( ' ', ' ' ); $order['toolid'] = 68; $order['notes'] = 'Ordered by API'; $order['params'] = array( 'make' => 'Blackberry', 'model' => '9800', 'network' => '512' ); $json = json_encode($order); status OK orderid xxxxxx message Order submitted successfully. Error Response code 400 message Reason 12 / 24

16 3.4 Instructions Get Instructions Get instructions for all manufacturers. GET array: makeid Make ID makename Make Name instructions Get Specific Instructions Get a specific instruction based on id. GET makeid Make ID makename Make Name instructions / 24

17 3.5 Error Responses Error Response Format Errors will be returned with a code and a message. HTTP <code same as below> { code :, message : } 14 / 24

18 4.0 API Class A class performing all API commands is available in PHP. For convenience, resellers who are unfamiliar with REST can use this class to communicate with the API server. In future updates, there may be new features available in REST but not incorporated in the API class. We encourage resellers to use the REST API however, we are confident that resellers who use the Cellunlocker.net class will still access the core features available. 4.1 Prerequisites The curl extension must be installed before using the API class. This extension is included since PHP and is most likely installed in your PHP setup. 4.2 Setup Initialize the API class and set your API key using the setapikey method. include_once('api.php'); $cu = new API(); $cu->setapikey('xxxxx'); // insert your API key here The API class is ready to communicate with Cellunlocker.net. 15 / 24

19 4.3 Commands Get Account Information $result = $cu->getaccount(); name Company Name credits 0.00 tier Tier # 16 / 24

20 4.3.2 Get Tools Get list of tools available for your account. $result = $cu->gettools(); toolid Tool ID toolname Tool Name description Description sorttype Carrier / Manufacturer / Software reqimei reqmake reqmodel reqmep reqpin reqserial reqnetwork reqservicetag reqkbh reqtype reqother reqprovider reqprd supportedmakes Array of supported makes hasaddparams (?) (?) In some tools, additional information is required. Please use "get specific tool" API call to verify. Please check all req(name) to see what is required and use the data (if provided) in get specific tool call when submitting an order. 17 / 24

21 4.3.3 Get Specific Tool Get a specific tool available for your account. $id = 1; // set the tool ID here $result = $cu->gettools($id); toolid Tool ID toolname Tool Name description Description sorttype Carrier / Manufacturer / Software reqimei reqmake reqmodel reqmep reqpin reqserial reqnetwork reqservicetag reqkbh reqtype reqother reqprovider reqprd supportedmakes Array of supported makes addparams (?) Additional parameters if required for tool (?) In some tools, additional information is required. Please check all req(name) to see what is required and use the data (if provided) in addparams when submitting an order. 18 / 24

22 4.3.4 Get Order History Get completed order history in descending order. $result = $cu->getorderhistory(); orderid Order ID imei IMEI unlockcode Unlock Code make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered datecompleted Date Completed 19 / 24

23 4.3.5 Get Order By Order ID Get order by order id. If it does not exist, an error is returned. $orderid = 12; // your order id $result = $cu->getorder($orderid); pendingorders: orderid Order ID imei IMEI make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered completedorders: orderid Order ID imei IMEI unlockcode Unlock Code make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered datecompleted Date Completed Error Response code 404 message No pending or completed orders found with order ID: xxxxxxxx 20 / 24

24 4.3.6 Get Pending Orders $result = $cu->getpendingorders(); numorders Number of Orders orders: orderid Order ID imei IMEI make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered Error Response code 404 message You have no pending orders 21 / 24

25 4.3.7 Search Order Search order by imei or order ID. $field = orderid ; // $field = imei ; $search = ; $result = $cu->searchorder($field, $search); numorders Number of Orders orders: orderid Order ID imei IMEI unlockcode Unlock Code make Phone Make model Phone Model status Order Status toolname Tool Name notes Notes dateordered Date Ordered datecompleted Date Completed Error Response imei: code 404 message Could not find an order with imei: xxxxxx order id: code 404 message Could not find an order with id: xxxxxx 22 / 24

26 4.3.8 Submit Order Input Field Type Description toolid (*) int Tool ID for order imeis (*) array An array containing imei(s) for your order params (?) array Additional parameters (make, model, network, mep, etc) notes string Notes regarding your order opt string Results will be sent to this Example: (*) Required fields (?) Additional parameters are required for some tools. Please use get specific tool API call to verify. Below is an example of including extra parameters. $toolid = 68; $imeis = array( ' ', ' ', ' ' ); $params = array( 'make' => 'Blackberry', 'model' => '9800', 'network' => '512' ); $notes = Ordered through API ; $result = $cu->submitorder($toolid, $imeis, $params, $notes); status OK orderid xxxxxx message Order submitted successfully. Error Response code 400 message Reason 23 / 24

27 4.3.9 Get Instructions Get instructions for all manufacturers. $result = $cu->getinstructions(); array: makeid Make ID makename Make Name instructions... Get a specific instruction based on id. $id = 1; $result = $cu->getinstructions($id); makeid Make ID makename Make Name instructions / 24