Information Systems:Infonet APIs - Revision history

Norwinu at 17:41, 16 January 2017

2017-01-16T17:41:52Z

Norwinu: /* What is an API? */

2017-01-16T17:36:22Z

What is an API?

Norwinu at 17:35, 16 January 2017

2017-01-16T17:35:14Z

Norwinu: /* Infonet API programs */

2017-01-16T17:34:48Z

Infonet API programs

Norwinu: /* Infonet API programs */

2017-01-16T17:34:18Z

Infonet API programs

Norwinu: /* Infonet API programs */

2017-01-16T17:33:55Z

Infonet API programs

Norwinu: /* IN2_APIWH.PGM */

2017-01-16T17:29:04Z

IN2_APIWH.PGM

Norwinu: /* Overview */

2017-01-16T17:27:55Z

Overview

Norwinu: Created page with "=Overview= Work has been started on creating API functionality for Infonet. Features will be documented here. ==What is an API==? An API (in this case a web API) allows com..."

2017-01-16T17:27:38Z

Created page with "=Overview= Work has been started on creating API functionality for Infonet. Features will be documented here. ==What is an API==? An API (in this case a web API) allows com..."

New page

=Overview=

Work has been started on creating API functionality for Infonet. Features will be documented here.

==What is an API==?

An API (in this case a web API) allows commonly used functions to be grouped together in one program to be used by other programs, returning data in a consistent format. For example, in a theoretical "Orders" program displaying a list of customers and their orders, the customer names can be made into clickable links that bring up a popup box showing their contact info. Instead of having the back-end code to query customer information in this orders program, the program queries the API and receives back customer information, which it can then display in whatever format is desired. Other programs query the API in the same manner but may present the data differently.

=Infonet API programs=

The two current programs are:

==IN2_SRVAPI.PGM==
* Customer info, session info

==IN2_APIWH.PGM==
* Warehouse transactions

@@ Line 19: / Line 19: @@
 =Implementation=
-The calls to these API programs are currently all made with jQuery Ajax. For each [[Information Systems:Notes on Infonet development | IN2 program]], there will most likely be a javascript file of the same name where the Ajax calls are contained. This code may be placed back into a WebSmart segment for more cohesive code, but currently it is easier to separate out javascript functionality into external scripts.
+The calls to these API programs are currently all made with jQuery Ajax. For each [[Information_Systems:Notes_on_Infonet_Development | IN2 program]], there will most likely be a javascript file of the same name where the Ajax calls are contained. This code may be placed back into a WebSmart segment for more cohesive code, but currently it is easier to separate out javascript functionality into external scripts.
 [[Category: Infonet]]

@@ Line 5: / Line 5: @@
 ==What is an API?==
-An API (in this case a web API) allows commonly used functions to be grouped together in one program to be used by other programs, returning data in a consistent format. For example, in a theoretical "Orders" program displaying a list of customers and their orders, the customer names can be made into clickable links that bring up a popup box showing their contact info. Instead of having the back-end code to query customer information in this orders program, the program queries the API and receives back customer information, which it can then display in whatever format is desired. Other programs query the API in the same manner but may present the data differently.
+An API (in this case a web API) allows commonly used functions to be grouped together in one program to be used by other programs, returning data in a consistent format. For example, in a theoretical "Orders" program displaying a list of customers and their orders, the customer names can be made into clickable links that bring up a popup box showing their contact info. Instead of having the back-end code to query customer information in this orders program, the program queries another program - an API program - and receives back customer information, which it can then display in whatever format is desired. Other programs query the API in the same manner but may present the data differently.
 =Infonet API programs=

← Older revision		Revision as of 17:35, 16 January 2017
Line 20:		Line 20:
	=Implementation=		=Implementation=
	The calls to these API programs are currently all made with jQuery Ajax. For each [[Information Systems:Notes on Infonet development \| IN2 program]], there will most likely be a javascript file of the same name where the Ajax calls are contained. This code may be placed back into a WebSmart segment for more cohesive code, but currently it is easier to separate out javascript functionality into external scripts.		The calls to these API programs are currently all made with jQuery Ajax. For each [[Information Systems:Notes on Infonet development \| IN2 program]], there will most likely be a javascript file of the same name where the Ajax calls are contained. This code may be placed back into a WebSmart segment for more cohesive code, but currently it is easier to separate out javascript functionality into external scripts.
		+
		+	[[Category: Infonet]]
		+	[[Category: WebSmart]]
		+	[[Category: Norwin]]

@@ Line 11: / Line 11: @@
 '''IN2_SRVAPI.PGM'''
-* Customer info, session info
+* Customer info (customer number)
 '''IN2_APIWH.PGM'''
-* Warehouse transactions (item number, warehouse).
+* Warehouse transactions (item number, warehouse)
-* Location transactions (item number, warehouse).
+* Location transactions (item number, warehouse)
 =Implementation=

@@ Line 10: / Line 10: @@
 All programs/functions return data in JSON unless otherwise noted.
-==IN2_SRVAPI.PGM==
+'''IN2_SRVAPI.PGM'''
 * Customer info, session info
-==IN2_APIWH.PGM==
+'''IN2_APIWH.PGM'''
 * Warehouse transactions (item number, warehouse).
 * Location transactions (item number, warehouse).

← Older revision		Revision as of 17:29, 16 January 2017
Line 15:		Line 15:

	==IN2_APIWH.PGM==		==IN2_APIWH.PGM==
−	* Warehouse transactions	+	* Warehouse transactions (item number, warehouse).
		+	* Location transactions (item number, warehouse).