Difference between revisions of "MOR API did create"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(15 intermediate revisions by 7 users not shown)
Line 8: Line 8:
* Methods: POST, GET(if allowed, not recomended)
* Methods: POST, GET(if allowed, not recomended)
<br><br>
<br><br>
===Parametres===
===Parametres (in this order only) ===


* u - username for authentication. '''Required'''.
* provider_id - Provider ID in MOR database, for which DID should be created '''Required'''.
* did - DID number to be created '''Required'''.
* did - DID number to be created '''Required'''.
* provider_id - Provider ID in MOR database, for which DID should be created '''Required'''.
 
* u - username for authentication. '''Required'''.
Note that when creating DID from '''Reseller'''`s account, provider_id parameter is '''not required''', but also can be used. In this case default provider id will be used.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
'''provider_id and did are included in hash. username is not included in hash.'''
<br><br>
<br><br>
===Request===
===Request===


Line 21: Line 25:
We send:
We send:


  HTML POST: http://<SERVER_IP>/billing/api/device_create/u=username&did=123456789&provider_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462
  HTML POST: http://<SERVER_IP>/billing/api/did_create?u=username&did=123456789&provider_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462




Now we can find these DIDs in GUI DID list.
Now we can find these DIDs in GUI DID list.


'''Note that username and password are not included in hash'''
<br><br>
<br><br>
===Returns===
===Returns===


Line 33: Line 37:
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <page>
  <page>
   <status>DID created</status>
   <status>
   <id>id of new DID</id>
      <success>DID created</success>
  </status>
   <did_details>
      <id>3</id>
  </did_details>
  </page>
  </page>
<br><br>
<br><br>
Line 41: Line 49:
'''Errors'''
'''Errors'''


* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
<?xml version="1.0" encoding="UTF-8"?>
* <error>Access Denied</error> - Only Admin, Accountant or Reseller may use API.
<page>
* <error>Provider was not found</error> - Enter existing Provider ID.
  <status>
* <error>Your are not authorized to use this Provider</error> - Specified Provider is not available to this user.
      <error>Error message</error>
* <error>You are not authorized to manage DIDs</error> - If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
  </status>
* <error>DID already exists</error> - Enter unique DID number.
</page>
* <error>Invalid DID specified</error> - Enter a valid (numeric) DID number.
 
* <error>DID creation failed</error>
Error messages:
 
* Incorrect hash – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* Access Denied – Only Admin, Accountant or Reseller may use API.
* Provider was not found – Enter existing Provider ID.
* Your are not authorized to use this Provider – Specified Provider is not available to this user.
* You are not authorized to manage DIDs – If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
* DID already exists – Enter unique DID number.
* Invalid DID specified – Enter a valid (numeric) DID number.
* DID creation failed – unknown error
<br><br>
<br><br>
=See also=
=See also=


* [[MOR API]]
* [[MOR API]]

Latest revision as of 06:57, 10 December 2020

Description

MOR API Create DID

Usage

  • Call: /api/did_create
  • Methods: POST, GET(if allowed, not recomended)



Parametres (in this order only)

  • u - username for authentication. Required.
  • provider_id - Provider ID in MOR database, for which DID should be created Required.
  • did - DID number to be created Required.

Note that when creating DID from Reseller`s account, provider_id parameter is not required, but also can be used. In this case default provider id will be used.

provider_id and did are included in hash. username is not included in hash.

Request

We have provider_id = 1, API Secret Key = secret. We want to create DID with number 123456789.

We send: 

HTML POST: http://<SERVER_IP>/billing/api/did_create?u=username&did=123456789&provider_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462


Now we can find these DIDs in GUI DID list.



Returns

Success 

<?xml version="1.0" encoding="UTF-8"?>
<page>
  <status>
     <success>DID created</success>
  </status>
  <did_details>
     <id>3</id>
  </did_details>
</page>



Errors 

<?xml version="1.0" encoding="UTF-8"?>
<page>
  <status>
     <error>Error message</error>
  </status>
</page>

Error messages:

  • Incorrect hash – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • Access Denied – Only Admin, Accountant or Reseller may use API.
  • Provider was not found – Enter existing Provider ID.
  • Your are not authorized to use this Provider – Specified Provider is not available to this user.
  • You are not authorized to manage DIDs – If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
  • DID already exists – Enter unique DID number.
  • Invalid DID specified – Enter a valid (numeric) DID number.
  • DID creation failed – unknown error



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_did_create&oldid=26061"