Authentication: Difference between revisions

From i4a API Wiki
Jump to navigation Jump to search
(Created page with "== About == this article discusses how to perform remote authentication using your i4a website and data from a remote website or program. It's important to note that the remote ...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 4: Line 4:
== Requirements ==
== Requirements ==
* SOAP.  The authentication protocol currently utilizes SOAP.  This is the mechanism that the i4a website uses to provide authentication.  This is a common protocol, with broad support and a lot of online resources that can provide both education as well as support for this.
* SOAP.  The authentication protocol currently utilizes SOAP.  This is the mechanism that the i4a website uses to provide authentication.  This is a common protocol, with broad support and a lot of online resources that can provide both education as well as support for this.
* A dedicated admin i4a account to use for this.
* You can manage your API login and Token values by logging into your site admin and selecing 'API Settings' from the Admin menu. On this screen, you can define a username/password to use with your API. This username will NOT count against your admin seats, however it can only be used to authenticate through the API and cannot be used as a regular admin acct. Your site should already have a token defined for it, but if you wish you can generate a new one. Please be aware that any changes to these values will require that any existing code that uses the i4a API must be updated with your changed values.
* The GUID token that is unique for each i4a website.  This value can be obtained by logging into your site admin, then choosing 'Site Stats' from the Admin dropdown menu. Within that page is a value labeled 'GUID'. Your vendor will need this value to use the authentication routines.
 
== Use ==
* To access the authentication routine, your vendor must first authenticate themselves.  You could think of this as an initial handshake so that both parties can then begin further communication.





Latest revision as of 17:52, 14 April 2017

About

this article discusses how to perform remote authentication using your i4a website and data from a remote website or program. It's important to note that the remote process need NOT be a website, it could be an application, even a mobile app or mobile website.

Requirements

  • SOAP. The authentication protocol currently utilizes SOAP. This is the mechanism that the i4a website uses to provide authentication. This is a common protocol, with broad support and a lot of online resources that can provide both education as well as support for this.
  • You can manage your API login and Token values by logging into your site admin and selecing 'API Settings' from the Admin menu. On this screen, you can define a username/password to use with your API. This username will NOT count against your admin seats, however it can only be used to authenticate through the API and cannot be used as a regular admin acct. Your site should already have a token defined for it, but if you wish you can generate a new one. Please be aware that any changes to these values will require that any existing code that uses the i4a API must be updated with your changed values.

Use

  • To access the authentication routine, your vendor must first authenticate themselves. You could think of this as an initial handshake so that both parties can then begin further communication.