DEVELOPER API


How do I use the developer API?


  The developer API is a RESTFUL interface, you need to add an API user, API KEY in the control panel within the Deveoper API section. You authenticate, we return a TOKEN, you use that TOKEN for 30 minutes, then you need to authenticate to get another TOKEN after the TOKEN expires , 

we provde examples using curl and we have a REST interface, We respond in XML or JSON. 

DEVELOPER FUNCTIONS


What functions are available in the Deveoper API?


  The developer API is new and in BETA, we are adding new functions every day, the list of available functions is as below:


  • Authenticate
  • List Ranges
  • Get Top up Balance
  • List Users
  • List Sites
  • List Departments
  • List Logged In VoIP Phones


   

TEST WITH CURL or OUR REST INTERFACE


What functions are available in the Developer API?


The best way to test before using in your desired programming languge is by using our REST interface here. REST Interface  or use curl.



You can download Curl here Curl Download


Curl is a third party tool often used for testing REST interfaces, this tool is not provided by nor supported by us.

EXAMPLE GETTING AUTH TOKEN
The best way to test before using the API in your desired programming langugae is using Curl or try our RESTFUL interface.

Try our REST interface here. REST Interface

You can download Curl here Curl Download

Curl is a third party tool often used for testing REST interfaces, this tool is not provided by nor supported by us.

Getting an API auth TOKEN is sending an HTTP request wih the client ID, UserID, Secret and KEY

the request would look like this, please pay especial attention the the lower case ot he URL entry point:

https://api.nodemax.com/auth/json/v1.0/{cid}/{uid}/{key}/{secret}

so with the query strings added:
The DEMO AUTH Details are:

cid: 1355
uid: 40
Demo KEY: SBKUNMKCHVWGABZUUHCXYETEOGOHBFWZ
Demo SECRET: TQZUYODQXGAXZLXPBHNDYGLOKTRSJUWZ
returned TOKEN:  9b72c530393347b5a94f80bf8306ea5e

The above details will only work on getting a Demo auth TOKEN and the TOKEN can be used to get the dialcodes only.

https://api.nodemax.com/auth/json/v1.0/1355/40/SBKUNMKCHVWGABZUUHCXYETEOGOHBFWZ/TQZUYODQXGAXZLXPBHNDYGLOKTRSJUWZ

If the format is correct with the correct auth details you will receive the TOKEN which you can use in
all future requestions until the TOKEN expires after 30 minutes, upon which time you request another auth TOKEN.

A successful auth requestion the response with look like this in JSON.

A response where the format is correct but the auth details are wrong will return unauthorised

TRY - FIRST API CALL

   Your first API request calls    
Get Auth TOKEN
Simple auth request
https://api.nodemax.com/auth/json/v1.0/{cid}/{uid}/{key}/{secret}
Request
Header
Response
Get DialCodes
Get dial codes
https://api.nodemax.com/voice/dialcodes/list/json/v1.0/{cid}]/{uuid}/{key}
Request
Header
Response

DEVELOPER SUPPORT


What support do I get using the API?


   We do not charge for using the developer API, support is 3 days via email only best effort.


Our support is for the REST interface only, we do not provide any programming support.


For same day email and priority support via email we charge £50 per month.  

Developer API
REST Interface