API endpoints

Application license list

Endpoint with which you can download a list of all licenses of a application. you can narrow the list only to active licenses and/or a specific license.

Request:
POST: https://apps.idosell.com/api/application/license
{
    application_id: (int) // application id
    developer: (string) // developer login
    ?api_license: (string) // license number
    ?active: bool // [optional] only active or deactive  
    sign: (string) // communication signature
}

Response:
{
  status: (enum['success', 'error']) // status  
  ?errors: [(string)] // list of errors 
  license: [{
      number: (string) // license number
      application_id: (int) // application id
      active: (bool) // is active
      trial: (bool) // is trial (demo) version
      test: (bool) // is test version
      client: {
      	id: (int) // IdoSell client id
        name: (string) // client company name
        lang: (string) // client language
      },
      pricing: {
      	type: (enum: ['payAsYouGo', 'fix_price']) // application price model
       	price: (number) // price for next invoice
        price_limit: (number) // current price limit
        ?last_price: (number) // last inviced amount 
        ?last_price_date: (string) // last invoiced date
        currency: (string) // price currency
        next_invoice_day: (string) // date for next invoice
      },
      technical: {
        installation_completed: (bool), // is innstalation completed
        installation_completed_date: (string), // date of instalation
        orderd_date: (string), // date of order license
        termination_date: (string) // planned date of shutdown 
        api_permissions: {
                    SYSTEM: (string) // Allowed values 'read'; 'write' ;'no access' 
                    CMS:    (string) // Allowed values 'read'; 'write' ;'no access' 
                    CRM:    (string) // Allowed values 'read'; 'write' ;'no access'
                    OMS:    (string) // Allowed values 'read'; 'write' ;'no access' 
                    PIM:    (string) // Allowed values 'read'; 'write' ;'no access'
                    WMS:    (string) // Allowed values 'read'; 'write' ;'no access' 
                }
            },
            isf: []
            selected_shops: [(string)] // list of shops

      }

Set price for application in "pay as you go" price model

For applications in the “pay as you go” fee model, you should send the amount of fees to be charged for the consumption of a particular license. Using this method, you can transmit the amount of fees within a set limit. The gateway will not accept an amount higher than the set limit. You can find information about the license, the amount of fees and the date of the last charge in the gateway “application license list”

Request:
POST: https://apps.idosell.com/api/application/license/setPrice
{
    application_id: (int) // application id
    developer: (string) // developer login
    api_license: (string) //license number
    price: (number) // price for next invoice 
    sign: (string) // communication signature
}

Response:
{
  status: (enum['ok', 'error']) // status   
  ?errors: [(string)] // list of errors
  sign: (string) // communication signature  
  license: {
    price: (number)  // price for next invoice
    next_invoice_day: (string) // date for next invoice
    price_limit: (number) // current price limit
    currency: (string) // price currency
  }   
}

Confirmation of installation

For “online” applications, sending a webhook with the inclusion of a new license is the same as accepting a request to start the process of installing an application instance for a given merchant. Since, depending on the system, this process can vary significantly between applications, we do not require an immediate response to this webhook.
When the online application installation is complete, notify IdoSell Apps that the process is complete by sending a webhook with information about the license and the application to which the installation applies.

Request:
POST: https://apps.idosell.com/api/application/installation/done
{
    api_license: (string) //license number
    application_id: (int) // application id
    developer: (string) // developer login
    sign: (string) // communication signature
}

Response:
{
    status: (enum['ok', 'error']) // status  
    ?errors: [(string)] // list of errors
    sign: (string) // communication signature  
}

When the information about the correct installation is received, the information is passed to the merchant, the trial period begins and the application is made visible in the menu of the administration panel (for “online iframe” applications).