API Documentation v1

Services

Get Services list

 /api/services

 GET

keyAPI Key
errorReturned Error if exists:
  • invlaid_key : Invalid API Key
idService ID
nameService name
priceService price per 1000 unit
minMinimum amount
maxMaximum amount
descriptionService description
extra_fieldExtra field for service if exists
periodPeriod for subscriptions

History

Get List of Orders History

 /api/history

 GET

keyAPI Key

 array of orders, each one has :

errorReturned Error if exists :
  • invlaid_key : Invalid API Key
idOrder ID
service_idService ID
linkOrder link
amountOrdered amount
totalTotal charge for order
statusOrder status :
  • canceled
  • pending
  • in_process
  • progressing
  • partial
  • completed
counter_currentCurrent amount of finished units
counter_finalFinal amount of finished units

Order status

Get Order status

 /api/status

 GET

keyAPI Key
idOrder id
errorReturned Error if exists :
  • invlaid_key : Invalid API Key
  • invalid_id : Invalid Order ID
idOrder ID
service_idService ID
linkOrder link
amountOrdered amount
totalTotal charge for order
statusOrder status :
  • canceled
  • pending
  • in_process
  • progressing
  • partial
  • completed
counter_currentCurrent amount of finished units
counter_finalFinal amount of finished units

New Order

Create a new order

 /api/order

 POST

keyAPI Key
linkLink
serviceService ID
extra_fieldExtra field (required only if service has an extra field)
amountUnits to order (required only if a service does not have a fixed amount and the service does not require multi line extra field)
errorReturned Error if exists :
  • invlaid_key : Invalid API Key
  • invalid_link : Invalid Link
  • invalid_service_id : Invalid Service ID
  • inactive_service : Requested Service is Inactive
  • invalid_extra_field : Extra field required but not given
  • invalid_amount : Invalid requested amount
  • insufficient_balance : You don't have sufficient funds
idOrder ID