{"id":885,"date":"2017-12-07T22:33:09","date_gmt":"2017-12-07T22:33:09","guid":{"rendered":"http:\/\/kb.powercode.com\/?post_type=ht_kb&p=885"},"modified":"2025-01-09T21:28:19","modified_gmt":"2025-01-09T21:28:19","slug":"powercode-api","status":"publish","type":"ht_kb","link":"https:\/\/kb.powercode.com\/?ht_kb=powercode-api","title":{"rendered":"Powercode API"},"content":{"rendered":"

The Powercode API represents a secure method for interfacing with Powercode programmatically. API endpoints are documented here. <\/a>Examples of proper API Endpoint usage and Powercode API capabilities can be found  on the same page.<\/a><\/p>\n

Generate an API Key<\/h3>\n

Powercode requires you to generate an API Key<\/strong> for each service that will make use of the API.<\/strong><\/p>\n

\"\"<\/p>\n

Go to Powercode Billing Server<\/strong> at Admin Mode > Config > API Management <\/strong>and click Generate New API Key. <\/strong><\/p>\n

\"\"<\/p>\n

Enter the origin IP and a description of the service you intend to interface with the Powercode API and click Sav<\/strong>e to create your API Key.<\/strong><\/p>\n

\"\"<\/p>\n

Powercode API Settings<\/strong><\/h3>\n

\"\"<\/p>\n

Generate New API Key:<\/strong> Allows creation of API keys for allowing API connections to your Powercode Billing server<\/strong>.<\/p>\n

Existing API keys<\/strong> are shown below the Generate New API Key <\/strong>button and can be edited or deleted using the Action <\/strong>dropdown. Editing an API Key allows you to regenerate the API Key string in addition to updating the Name and IP address.<\/p>\n

Logging<\/strong><\/h4>\n
    \n
  • API Notification Email: <\/strong>Enables a nightly notification email containing API Log<\/strong> updates.<\/li>\n
  • Number of Logs to Store:<\/strong> Sets the number of entries kept in the API Log<\/strong><\/li>\n
  • Log both Success and Failure Messages:<\/strong>  Enables the log  to save all successful and unsuccessful captured API attempts. By default Powercode only logs unsuccessful API attempts.<\/li>\n
  • View API Logs<\/strong>: Click to access the API logging on your Powercode Billing Server.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"

    The Powercode API represents a secure method for interfacing with Powercode programmatically. API endpoints are documented here. Examples of proper API Endpoint usage and Powercode API capabilities can be found  on the same page. Generate an API Key Powercode requires you to generate an API Key for each service that will make…<\/p>\n","protected":false},"author":4,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":[],"ht-kb-category":[104,113],"ht-kb-tag":[],"_links":{"self":[{"href":"https:\/\/kb.powercode.com\/index.php?rest_route=\/wp\/v2\/ht-kb\/885"}],"collection":[{"href":"https:\/\/kb.powercode.com\/index.php?rest_route=\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/kb.powercode.com\/index.php?rest_route=\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/kb.powercode.com\/index.php?rest_route=\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/kb.powercode.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=885"}],"version-history":[{"count":6,"href":"https:\/\/kb.powercode.com\/index.php?rest_route=\/wp\/v2\/ht-kb\/885\/revisions"}],"predecessor-version":[{"id":1630,"href":"https:\/\/kb.powercode.com\/index.php?rest_route=\/wp\/v2\/ht-kb\/885\/revisions\/1630"}],"wp:attachment":[{"href":"https:\/\/kb.powercode.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=885"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/kb.powercode.com\/index.php?rest_route=%2Fwp%2Fv2%2Fht-kb-category&post=885"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/kb.powercode.com\/index.php?rest_route=%2Fwp%2Fv2%2Fht-kb-tag&post=885"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}