SQL Server

CardConnect Test API Credentials

See more CardConnect Examples

To test and validate site-level credentials, you can make a GET request with no body to the base URL. SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    --  This example assumes the Chilkat API to have been previously unlocked.
    --  See Global Unlock Sample for sample code.

    --  The CardConnect REST Web Service base URL includes a protocol, host, port and servlet specification.
    --  
    --  For example:
    --  https://<site>.cardconnect.com:<port>/cardconnect/rest/
    --  
    --  This represents an HTTPS request to the REST web service base URL. 
    --  The servlet name is fixed within the application; the host and port are assigned by CardConnect. 

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', 'API_USERNAME'
    EXEC sp_OASetProperty @http, 'Password', 'API_PASSWORD'

    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://<site>.cardconnect.com:<port>/cardconnect/rest/'
    DECLARE @responseStr nvarchar(4000)
    EXEC sp_OAMethod @http, 'QuickGetStr', @responseStr OUT, @url

    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    --  If we get a 200 response status and an HTML response saying "CardConnect REST Servlet", then our credentials are correct.

    EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
    PRINT 'response status code = ' + @iTmp0


    PRINT 'response string:'

    PRINT @responseStr

    --  Sample output:

    --  response status code = 200
    --  response string:
    --  <html lang="en"><body><h1>CardConnect REST Servlet</h1></body></html>

    EXEC @hr = sp_OADestroy @http


END
GO