Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
wapic [2019/01/30 09:29]
127.0.0.1 external edit
— (current)
Line 1: Line 1:
-====== Web API for Control (WAPIC, Coelacanth, API) ====== 
- 
- 
- 
-===== Description ===== 
- 
- 
- 
-Starting with Control 5.1, users now have the ability to integrate internal and external applications with the Control database using an [[http://en.wikipedia.org/wiki/Application_programming_interface|API]]. The API for Cyrious uses the REST standard for all client & server communication. 
- 
- 
- 
-===== Requirements ===== 
-  * Control 5.1 or later. 
-  * A valid subscription to the API service. Contact your Cyrious salesperson for more information on pricing. 
- 
- 
- 
-===== Documentation ===== 
- 
- 
- 
-Technical Reference Documentation is provided, you will need a working knowledge of web technologies and web programming to utilize this documentation. It is not meant as a how-to or step-by-step guide for end users. 
- 
- 
- 
-{{ :2014-07-07_wapic_specifications.pdf|}} 
- 
- 
- 
-===== Database Preparation ===== 
- 
- 
- 
-Users with databases prior to OOB v2.80 must undergo a database preparation routine to add the necessary tables, views, constraints, functions, stored procedures, and adjustment column field types to be compatible with the API service. This is a process that Cyrious must do to your database in order for the API to function properly. 
-  * [[wapic_-_database_preparation]] 
- 
- 
- 
-===== Installation ===== 
-  * [[wapic_-_manual_installation]] 
-  * [[wapic_-_msi_installation]] 
-  * [[wapic_-_register_coelacanth_service]] 
-  * [[wapic_-_how_do_i_access_the_api_from_outside_my_network]] 
-  * [[wapic_-_creating_a_sql_report_to_view_api_errors]] 
- 
- 
- 
-===== Testing ===== 
-  * [[wapic_-_request_test_system_page]] 
-  * [[wapic_-_post_new_company_test]] 
-  * [[wapic_-_update_an_existing_company_record_using_patch]] 
- 
- 
- 
-===== Troubleshooting ===== 
-  * [[wapic_-_401_unauthorized]] 
-  * [[wapic_-_403_forbidden]] 
-  * [[wapic_-_setting_the_database_connection_strings_in_coelacanth.servicehost.exe.config]] 
-  * [[wapic_-_delete_coelacanth.servicehost_service]] 
- 
- 
-