• To Doba Home
  • Sandbox Retailer API

    Sandbox Retailer API - Answers

    1. What is the Sandbox Retailer API?

      When you are ready to begin development you will be provided with account information for use in the sandbox environment as well as in the production environment. We ask that all development be performed using the sandbox. The sandbox is a separate server that mimics Doba's production server which allows you to develop your implementation without fear of impacting the production environment.

      The Sandbox Retailer Application Programing Interface was created so that you could test the potential API methods and automate them for your application. It allows you to test things in a controlled environment so that if you do something potentially dangerous, it doesn’t affect your business negatively until you know how to handle all rules and exceptions.

       
    2. What is the difference between the Sandbox Retailer API and the Enterprise Retailer API?

      When you are ready to begin development you will be provided with account information for use in the sandbox environment as well as in the production environment. We ask that all development be performed using the sandbox. The sandbox is a separate server that mimics Doba's production server which allows you to develop your implementation without fear of impacting the production environment.

      The Sandbox Retailer API is a testing environment and the Enterprise Retailer API is a live environment API. The Sandbox API will allow all API methods except for ‘fundOrder’. The Enterprise API will allow all API calls with no exception. The Sandbox API with throttle API calls at 10 calls a minute. The Enterprise API will allow up to 100 calls a minute.

       
    3. What are the limits of the Sandbox Retailer API?

      The Sandbox Retailer API only allows up to 10 calls per minute or 14,400 calls per day. It also cannot successfully fund an order using the ‘fundOrder’ method.


       
     
    1. What do my error codes mean?

      The error codes and descriptions are the same for both the Sandbox and the live Retailer APIs. The following link will take you to the codes: http://www.doba.com/developer/20110301/api_introduction_retailer.php#Failure_Codes

       
    2. How do you use the ‘fundOrder’ API call with the Sandbox Retailer API?

      The ‘fundOrder’ method cannot be used successfully in the sandbox environment. This is due to the fact that there is no true merchant account processor for payments. You would need to fund your order manually in the UI. You must fund the orders by logging into the Sandbox UI, click on the “Orders” page, click on the order in question and click on the yellow “Change Order Status” button and select the ‘Funded’ status.



       
    3. Why is my retailer ID number different between the Sandbox and the Enterprise accounts?

      The retailer ID number is given for each account created, no matter where that account is created. There is no true link between the Sandbox account and the Enterprise account. It is also part of the credential set, it helps differentiate the accounts as well.

       
    4. I know my credentials are good, why do I get a ‘2016’ error?

      The 2016 error means “Permission denied invalid credentials”. Credentials include the URL that you are posting your request to, username, password, and retailer ID. All of these credentials will be checked before your API call will be addressed. Usually when you get this error, it is because your URL doesn’t match the credentials you are providing. Use the sandbox URL

      (https://sandbox.doba.com/api/20110301/xml_retailer_api.php) with the respective sandbox credentials.

       
    5. What is the URL for the Sandbox Retailer API?

      https://sandbox.doba.com/api/20110301/xml_retailer_api.php is the XML API URL

      If you are planning on using SOAP the following are the URLs:
    Product Methods: https://sandbox.doba.com/soap/20110301/wsdl/ApiRetailerSearch.wsdl
    Order Methods: https://sandbox.doba.com/soap/20110301/wsdl/ApiRetailerOrder.wsdl

     
    1. How do you get an ‘order_group_id’ in order to fund multiple orders simultaneously?

      The ‘order_group_id’ does not exist in the sandbox environment. The only way to get one is to select all of the orders you would like to fund and get started actually paying for it. As the merchant account doesn’t exist in the sandbox environment, you would be required to change the status on the order level. In the sandbox environment, you cannot mass update order statuses to ‘Funded’. They must all be changed one at a time.

       
    2. How can I tell what my current API call count is?

      This is not logged in the sandbox environment. However, you will get an error once you pass 14,400 calls. The error that you will be given is 390 ‘Call limit reached’.

      You must set up your own logs for the API calls that you send and the responses our servers give you. You should also be counting the calls that you are sending out. This is a best practice when working with APIs.

    Did you find this article helpful?