Internal GCManage API - Revision history

Eumhoefer: Eumhoefer moved page GCManage API to Internal GCManage API

2017-07-10T16:49:21Z

Eumhoefer moved page GCManage API to Internal GCManage API

← Older revision	Revision as of 16:49, 10 July 2017
(No difference)

Eumhoefer: Added Internal to GCAPI

2017-07-10T16:41:57Z

Added Internal to GCAPI

← Older revision		Revision as of 16:41, 10 July 2017
Line 1:		Line 1:
	=Authentication With GCManage 2.0=		=Authentication With GCManage 2.0=
	Before calling any of the [[GCAPI]] services, an application must authenticate and obtain a "passcode" from GCManage. GCManage provides a service to fetch the accounts available to a user and their "passcodes" given the user's name and password. This service is useful when implementing an third-party login page for GCManage or when calling services on [[GCAPI]]. The format for calling this function is:		Before calling any of the [[Internal GCAPI]] services, an application must authenticate and obtain a "passcode" from GCManage. GCManage provides a service to fetch the accounts available to a user and their "passcodes" given the user's name and password. This service is useful when implementing an third-party login page for GCManage or when calling services on [[Internal GCAPI]]. The format for calling this function is:
	https://[GCManage-URL]/services.php?sname=LoginService&username=[username]&password=[plain-text-password]&listaccounts=true		https://[GCManage-URL]/services.php?sname=LoginService&username=[username]&password=[plain-text-password]&listaccounts=true

Line 29:		Line 29:
	* url: Base URL used to communicate with the system		* url: Base URL used to communicate with the system

	== Accessing [[GCAPI]] From GCManage2 ==		== Accessing [[Internal GCAPI]] From GCManage2 ==
	The proxy systems use on GCManage2 for external users accessing the API is not always listening. This is a security feature; proxies timeout after 30 minutes of inactivity and are opened on demand.		The proxy systems use on GCManage2 for external users accessing the API is not always listening. This is a security feature; proxies timeout after 30 minutes of inactivity and are opened on demand.

	If you need to talk to [[GCAPI]], rather than calling LoginService, you may call the OpenProxyService instead.		If you need to talk to [[Internal GCAPI]], rather than calling LoginService, you may call the OpenProxyService instead.

	=== OpenProxyService ===		=== OpenProxyService ===

Ngh: /* OpenProxyService */

2012-11-23T16:20:04Z

OpenProxyService

← Older revision		Revision as of 16:20, 23 November 2012
Line 43:		Line 43:
	"accountName": "Account Name",		"accountName": "Account Name",
	"system_id": "314XXX",		"system_id": "314XXX",
	"url": "https://[GCManage-URL]:[Port Number]/~~?passcode=XXXXXX~~",		"url": "https://[GCManage-URL]:[Port Number]/"
	"passcode": "XXXXXX"		"passcode": "XXXXXX"
	}		}

Ngh at 18:49, 16 November 2012

2012-11-16T18:49:50Z

← Older revision		Revision as of 18:49, 16 November 2012
Line 28:		Line 28:
	* passcode: Effectively the "password" for the system. The passcode changes daily in the very early morning, so it needs to be fetched again every day		* passcode: Effectively the "password" for the system. The passcode changes daily in the very early morning, so it needs to be fetched again every day
	* url: Base URL used to communicate with the system		* url: Base URL used to communicate with the system

			== Accessing [[GCAPI]] From GCManage2 ==
			The proxy systems use on GCManage2 for external users accessing the API is not always listening. This is a security feature; proxies timeout after 30 minutes of inactivity and are opened on demand.

			If you need to talk to [[GCAPI]], rather than calling LoginService, you may call the OpenProxyService instead.

			=== OpenProxyService ===
			The format for calling this function is:
			https://[GCManage-URL]/services.php?sname=OpenProxyService&username=[username]&password=[plain-text-password]&system_id=[system-id]

			Results look like:
			{
			"result": "OK",
			"accountName": "Account Name",
			"system_id": "314XXX",
			"url": "https://[GCManage-URL]:[Port Number]/?passcode=XXXXXX",
			"passcode": "XXXXXX"
			}

			On OK result, the proxy is listening and you may call down to GCAPI using the returned URL and passcode of the system. Note that the port will timeout after 30 minutes of inactivity. You will need to recall this service to reopen the port if this happens. It is safe to call this service even if the port is already active.

	=Legacy Authentication With GCManage 1.5=		=Legacy Authentication With GCManage 1.5=

Ngh at 21:20, 3 October 2012

2012-10-03T21:20:43Z

← Older revision		Revision as of 21:20, 3 October 2012
Line 31:		Line 31:
	=Legacy Authentication With GCManage 1.5=		=Legacy Authentication With GCManage 1.5=
	Authentication was a little different in GCManage 1.5.x:		Authentication was a little different in GCManage 1.5.x:
	~~http~~://[GCManage-URL]/services.php?sname=remotelogin&username=[username]&rawpassword=[plain-text-password]		https://[GCManage-URL]/services.php?sname=remotelogin&username=[username]&rawpassword=[plain-text-password]

	The result of the call will be be a list of accounts, one per line, that this user can access. Each line is of the format:		The result of the call will be be a list of accounts, one per line, that this user can access. Each line is of the format:

Ngh at 21:19, 3 October 2012

2012-10-03T21:19:53Z

← Older revision		Revision as of 21:19, 3 October 2012
Line 31:		Line 31:
	=Legacy Authentication With GCManage 1.5=		=Legacy Authentication With GCManage 1.5=
	Authentication was a little different in GCManage 1.5.x:		Authentication was a little different in GCManage 1.5.x:
	http://[GCManage-URL]/services.php?sname=remotelogin&username=[username]&~~password~~=[~~php~~-~~crypted~~-password]		http://[GCManage-URL]/services.php?sname=remotelogin&username=[username]&rawpassword=[plain-text-password]

	The result of the call will be be a list of accounts, one per line, that this user can access. Each line is of the format:		The result of the call will be be a list of accounts, one per line, that this user can access. Each line is of the format:

Ngh at 19:53, 2 August 2012

2012-08-02T19:53:03Z

← Older revision		Revision as of 19:53, 2 August 2012
Line 1:		Line 1:
	= ~~Introduction~~ =		=Authentication With GCManage 2.0=
	GCManage ~~API is used~~ to ~~get~~ passcodes ~~to systems~~		Before calling any of the [[GCAPI]] services, an application must authenticate and obtain a "passcode" from GCManage. GCManage provides a service to fetch the accounts available to a user and their "passcodes" given the user's name and password. This service is useful when implementing an third-party login page for GCManage or when calling services on [[GCAPI]]. The format for calling this function is:
			https://[GCManage-URL]/services.php?sname=LoginService&username=[username]&password=[plain-text-password]&listaccounts=true

	* URL: ~~<nowiki>https~~:~~//gcmanage~~.~~grandcare~~.~~com/services~~.~~php?sname=<serviceName>&username=<username>&rawpassword=<password></nowiki>~~		The result of the call will be be a JSON encoded string that includes a list of accounts that this user can access:
	* Use GET or POST requests		{
	* Where serviceName corresponds to a valid service name (services listed below)		"result": "OK",
	* Username is your GCManage username		"id": "c07c11ee-3a27-47e5-9c81-7857de364cdc",
	* Password is your GCManage password		"lastLogin": "never",
			"accounts": [
			{
			"accountName": "...",
			"systemId": "...",
			"passcode": "...",
			"url": "..."
			},
			...
			]
			}

	~~== Services ==~~		* result: OK if the call succeeded, ERROR otherwise
	~~=== Remote Login ===~~		* errorMessage: Only appears if result is ERROR. Explanation of why call failed
	* ~~Service Name~~: ~~remotelogin~~		* id: User's unique ID
	* ~~Results~~		* lastLogin: User's last login date/time
	** ~~System URL (used to call down to~~ the ~~[[Como API]])~~		* accounts: Array of accounts this user has access to
	** Passcode ([[Como API]] Authentication code)		* accountName: Long name for the account
	** Account Name		* systemId: ID of associated hardware for the account
	** System ID		* passcode: Effectively the "password" for the system. The passcode changes daily in the very early morning, so it needs to be fetched again every day
			* url: Base URL used to communicate with the system

	~~'''Example'''~~		=Legacy Authentication With GCManage 1.5=
	~~curl -k "https~~://~~gcmanage.grandcare.com~~/services.php?sname=remotelogin&username=~~foo~~&~~rawpassword~~=~~bar"~~		Authentication was a little different in GCManage 1.5.x:
	~~http://gcmanage~~.~~grandcare.com~~:~~21000/~~@@~~UDBvSFB6OC9EeDgxUDBJSFB6OC9hZz09~~@@~~main~~@@~~Account MyAccount~~ - ~~314-999998~~		http://[GCManage-URL]/services.php?sname=remotelogin&username=[username]&password=[php-crypted-password]
	~~http~~:~~//gcmanage~~.~~grandcare~~.~~com:22000/@@UHo4L0lUOENQeWMvUHo4clB6OC9UUT09@@~~main~~@@Account MyAccount2 - 314-999999~~
			The result of the call will be be a list of accounts, one per line, that this user can access. Each line is of the format:
	~~<system URL>@@<Passcode>@@main@@<~~Account ~~Name> - <System ID>~~		[como-system-url]@@[passcode]@@[starting-point]@@[account-description]

			* como System URL: The URL to use to get to the system, either proxied or direct, based on the caller's location and other various elements on the server
			* passcode: Effectively the "password" for the system. The passcode changes daily in the very early morning, so it needs to be fetched again every day
			* Starting Point: The initial menu screen the user sees when connecting to the system. Either "main" for the Main Menu or "tv" for the TV Operations Page
			* Account Description: An identifier giving various information about the account

Ngh at 18:42, 1 August 2012

2012-08-01T18:42:31Z

← Older revision		Revision as of 18:42, 1 August 2012
Line 2:		Line 2:
	GCManage API is used to get passcodes to systems		GCManage API is used to get passcodes to systems

	* URL: https://gcmanage.grandcare.com/services.php?sname=<serviceName>&username=<username>&rawpassword=<password>		* URL: <nowiki>https://gcmanage.grandcare.com/services.php?sname=<serviceName>&username=<username>&rawpassword=<password></nowiki>
	* Use GET or POST requests		* Use GET or POST requests
	* Where serviceName corresponds to a valid service name (services listed below)		* Where serviceName corresponds to a valid service name (services listed below)

Ngh at 17:51, 1 August 2012

2012-08-01T17:51:56Z

← Older revision		Revision as of 17:51, 1 August 2012
Line 12:		Line 12:
	* Service Name: remotelogin		* Service Name: remotelogin
	* Results		* Results
	** System URL (used to call down to the Como API)		** System URL (used to call down to the [[Como API]])
	** Passcode (Como API Authentication code)		** Passcode ([[Como API]] Authentication code)
	** Account Name		** Account Name
	** System ID		** System ID

Ngh at 17:51, 1 August 2012

2012-08-01T17:51:32Z

← Older revision		Revision as of 17:51, 1 August 2012
Line 1:		Line 1:
			= Introduction =
	GCManage API is used to get passcodes to systems		GCManage API is used to get passcodes to systems

Line 7:		Line 8:
	* Password is your GCManage password		* Password is your GCManage password

			== Services ==
	=== Remote Login ===		=== Remote Login ===
	* Service Name: remotelogin		* Service Name: remotelogin