MRRly

Help center / Getting started

API

insert

Insert data to import data. For using API just call URL https://app.mrrly.io/api/insert and send using GET or POST method next varibles:

  • invoice_createdInvoice creation date, date format: YYYY-mm-dd.
  • invoice_idInvoice id, text field, maximum 100 characters.
  • customer_idCustomer id, text field, maximum 100 characters.
  • paid_amountA value of payment, float.
  • paid_currencyA currency of payment, using ISO 4217 standard specifies three-letter ("Alpha-3").
  • paid_userIf you use licenses or users in your plans show how many users/lisenses your customer bought else use 1 as default value.
  • paid_planPlan id, text field, maximum 45 characters.
  • period_startA date when period start, date format: YYYY-mm-dd.
  • period_endA date when period end, date format: YYYY-mm-dd.
  • custom_field_1optional field
  • custom_field_2optional field
  • custom_field_3optional field
  • custom_field_4optional field
  • custom_field_5optional field
  • login_hashMD5 of you login.
  • control_hashMD5 of concatenation of all variables and secret_key. PHP example:
    $control_hash=md5($invoice_created.$invoice_id.$customer_id.$paid_amount.$paid_currency.$paid_user.$paid_plan.$period_start.$period_end.$login_hash.$secret_key);
    or
    $control_hash=md5($invoice_created.$invoice_id.$customer_id.$paid_amount.$paid_currency.$paid_user.$paid_plan.$period_start.$period_end.$custom_field_1.$login_hash.$secret_key);

API will return JSON answer.

Our API has a limit of 100 requests per second for each IP.

Exmaple

  • secret_key: ********
  • invoice_created: 2024-11-11
  • invoice_id: 1234-566
  • customer_id: mrr1
  • paid_amount: 100
  • paid_currency: EUR
  • paid_user: 1
  • paid_plan: annualy
  • period_start: 2024-11-11
  • period_end: 2025-11-10
  • login_hash: 11b614075f0b726b4b25bd25e9687a39
  • control_hash: 48c668909e8ff6f7956f040789220616
  • https://app.mrrly.io/api/insert/?login_hash=11b614075f0b726b4b25bd25e9687a39&invoice_created=2024-11-11&invoice_id=1234-566&customer_id=mrr1&paid_amount=100&paid_currency=EUR&paid_user=1&paid_plan=annualy&period_start=2024-11-11&period_end=2025-11-10&control_hash=48c668909e8ff6f7956f040789220616
  • Answer:
    {
    	"state":"success",
    	"message":"request succeded",
    	"request": {
    		"invoice_created":"2024-11-11",
    		"invoice_id":"1234-566",
    		"customer_id":"mrr1",
    		"paid_amount":"100",
    		"paid_currency":"EUR",
    		"paid_user":"1",
    		"paid_plan":"annualy",
    		"period_start":"2024-11-11",
    		"period_end":"2025-11-10",
    		"custom_field_1":"",
    		"custom_field_2":"",
    		"custom_field_3":"",
    		"custom_field_4":"",
    		"custom_field_5":"",
    	}
    }
    				
Our website uses cookies

We use cookies on our website to give you a better experience, improve performance and for analytics. Find out more and control how cookies are used at our Cookie policy. By using this website you agree to the use of cookies.

Accept cookies