Mobule.API - ask your manager

Requests

1. All requests to the Mobule.API should be made with Http.POST
2. Generate Mobule.API + '/' + serviceName + '.' + methodName
3. Method params must be sent as application/x-www-form-urlencoded
4. Requests must be signed

• Params starting with partner. must be excluded from sign
• Additional info can be sent as parameters with names starting with meta..

Responses

1. All responses from Mobule are in JSON.

   • Http Status Code - is not part of api specification and always should be 200.
   • Format of successful response

   {
         "status" : 200,
         "method" : "service.method",
         "response" : ...response entity as json...
   }
   

• Format of error response:

  {
        "status" : "int != 200",
        "method" : "service.method",
        "message" : "Error message"
  }
  

Every method should have at least this fields**:**

• @partner.alias - Partner alias you got from manager
• @partner.sign

Generating Sign

• The signature in the request is passed as a named parameter partner.sign
• ALL parameters that are passed in the body of the POST request (GET parameters are not considered), except those whose names begin with  partner. and meta., participate in the formation of the signature.
• Formation:

  1. Form a set of parameters in any convenient way.

  2. Take a list of names of all parameters that participate in the request.

  3. Filter the list of names. Keep only those names that do NOT start with partner. and meta..

  4. Sorting in lexicographical order.

  5. Full algorithm for signature generation (pseudo code):

     val params = Map[Name,Value]
     
     val joined = names
       .filter( name => name.startsWith("partner.") == false && name.startsWith("meta.") == false)
       .sorted
       .map( name => name + "=" + params(name))
       .join("&")
     
     // Соединительная частица "&" между 'joined' и 'serviceName' проставляется в любом случае, даже при отсутствии параметров.
     val sign = md5(joined + "&" + serviceName + "." + methodName + "&" + "Идентификатор Партнера" + "&" + "Секретный ключ")
     
     

Complete example of signature generation