How to use XML API with Asp.net

[rawat]

Hello,

How to use XML API with Asp.net ,please help for coding,how to use XML API for Create Account .

Actually i m using

XML and JSON APIs

But facing Authentication Error.and I don't know PHP or Pearl.....

ThanX
rawat

 

[cPanelDavidN]

Hi Rawat,

I'm not too familiar with ASP, but I imagine it shouldn't be hard. Your ASP script must:
1) make a URL request
2) that contains proper authentication headers

You can test how the XML-API works directly in your browser. Manually logging into your server (this will set the authentication data in subsequent headers) and then make a direct XML-API call. A good test URL would be:

http://yourserver.com:2086/xml-api/version

Maybe someone with ASP experience can provide an example piece of code.

Regards,
-DavidN


UPDATE: placed example url in code block so the wysiwyg doesn't try to make a direct URL

 

[MattDees]

if I remember correctly the work flow for .NET auth header via the default method is:

1. Client sets up request object
2. client sends request to server w/o auth header
3. server responds stating that auth is needed
4. client sends request again w/ auth header
5. server accepts authentication

The problem is that the way that cpsrvd responds to auth requests doesn't work with how .NET handles HTTP Basic auth in it's default implementation (this can be said for apache under certain configurations as well).

The change that has to happen, is that:

1. Client set up request object
2. client sends request w/ auth headers
3. server authenticates

check out:

ie-soft.de Blog - C#: Create a WebRequest with HTTP Basic Authentication

for an example of how to do this, if this does not work for you, I've seen a few examples on how to do this and will hunt one down for you.

 

[rawat]

Authentication Error

Hello Sir,

when i m trying to create Account with XML API after login in cPanel Control Panel

http://174.36.185.116:2086/xml-api/...p=n&cpmod=x3&[email protected][email protected]&contact [email protected]&domain=domain2011.info&useregns=0&reseller=0

Account Created but i m by Asp.net application,Execute Authentication Error............

Pls reply and give me a example for CreateAccount with XML API with Asp.net

ThanX

 

[rawat]

XML API Authentication

Hello Sir,

I m trying this code for Authentication but facing Error

string url = "http://test.com:2086";
WebRequest myReq = WebRequest.Create(url);

string username = "Test";
string password = "test";
string usernamePassword = username + ":" + password;
CredentialCache mycache = new CredentialCache();
mycache.Add(new Uri(url), "Basic", new NetworkCredential(username, password));
myReq.Credentials = mycache;
myReq.Headers.Add("Authorization", "Basic " + Convert.ToBase64String(new ASCIIEncoding().GetBytes(usernamePassword)));

WebResponse wr = myReq.GetResponse();
Stream receiveStream = wr.GetResponseStream();
StreamReader reader = new StreamReader(receiveStream, Encoding.UTF8);
string content = reader.ReadToEnd();

 

[MattDees]

So, I just verified that this works for authentication:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Net;
using System.IO;

namespace ListAccount
{
    class Program
    {
        static void Main(string[] args)
        {
            string url = "http://129.169.1.2:2086/xml-api/listaccts";
            HttpWebRequest req = HttpWebRequest.Create(url) as HttpWebRequest;

            string user = "root";
            string pwd = "x";

            string auth = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes(user + ":" + pwd));
            req.PreAuthenticate = true;
            req.AuthenticationLevel = System.Net.Security.AuthenticationLevel.MutualAuthRequested;
            req.Headers.Add("Authorization", auth);

            req.UserAgent = "cPanel .NET C# authenticator test script";
            WebResponse resp = req.GetResponse();
            Stream receiveStream = resp.GetResponseStream();
            StreamReader reader = new StreamReader(receiveStream, Encoding.UTF8);
            string content = reader.ReadToEnd();

            System.Console.WriteLine(content);
            System.Console.Read();   
        }
    }
}

 

[rawat]

XML API For Create Account with ASP.net

Hello Sir,

but we will call XML API for Create Account with XML API.Please Provide a example....

ThanX


-------------------------

So, I just verified that this works for authentication:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Net;
using System.IO;

namespace ListAccount
{
    class Program
    {
        static void Main(string[] args)
        {
            string url = "http://129.169.1.2:2086/xml-api/listaccts";
            HttpWebRequest req = HttpWebRequest.Create(url) as HttpWebRequest;

            string user = "root";
            string pwd = "x";

            string auth = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes(user + ":" + pwd));
            req.PreAuthenticate = true;
            req.AuthenticationLevel = System.Net.Security.AuthenticationLevel.MutualAuthRequested;
            req.Headers.Add("Authorization", auth);

            req.UserAgent = "cPanel .NET C# authenticator test script";
            WebResponse resp = req.GetResponse();
            Stream receiveStream = resp.GetResponseStream();
            StreamReader reader = new StreamReader(receiveStream, Encoding.UTF8);
            string content = reader.ReadToEnd();

            System.Console.WriteLine(content);
            System.Console.Read();   
        }
    }
}

 

[MattDees]

Please consult the xml-api createacct documentation and modify the example I gave, it should work fine.

CreateAccount < AllDocumentation/AutomationIntegration < TWiki

 

[B12Org]

When I try that it works well for everything except for create account - that one always throws an exception - although the command does work as I get the account created email and if I try again it immediately fails becuase the user exists.

{"Unable to read data from the transport connection: The connection was closed."}
[System.IO.IOException]: {"Unable to read data from the transport connection: The connection was closed."}
Data: {System.Collections.ListDictionaryInternal}
HelpLink: null
InnerException: null
Message: "Unable to read data from the transport connection: The connection was closed."
Source: "System"
StackTrace: " at System.Net.ConnectStream.Read(Byte[] buffer, Int32 offset, Int32 size)\r\n at System.IO.StreamReader.ReadBuffer()\r\n at System.IO.StreamReader.ReadToEnd()\r\n

Per the message the error occurs here - on the 2nd line

StreamReader reader = new StreamReader(receiveStream, Encoding.UTF8);
String strResponse = reader.ReadToEnd();

it seems to occur on any of those commands that send out emails - create account, suspend account, etc - but none of the other commands do that.

We dont use proxies or anything like that.
Any ideas why?

 

[Eric]

Howdy,

I'm able to use the same program Matt posted and changed the string url line to be this

string url = "http://grimlock:2086/xml-api/createacct?username=myuser&password=test$1234&domain=domain.tld";

I get a created account. I'm using a simple console app. Give that a try. If you have problems let me know I'll help as best I can.

Thanks!

 

[B12Org]

Hi,

We are using this:

http://cpaneltest.local:2086/xml-ap...limited&useregns=0&reseller=0&mxcheck=remote&

which basically is sent using this code

    private String SendRequest(String method, String variables, String server)
    {
        //Dont bail from a self signed cert or other cert error
        if (Global.UseSSL)
            ServicePointManager.ServerCertificateValidationCallback = new RemoteCertificateValidationCallback(RemoteCertificateValidation);

        String url = String.Format("http{0}://{1}:{2}/xml-api/{3}?{4}", Global.UseSSL ? "s" : "", server, Global.UseSSL ? "2087" : "2086", method, variables);
        HttpWebRequest req = HttpWebRequest.Create(url) as HttpWebRequest;

        String auth = String.Format("Basic {0}", Convert.ToBase64String(System.Text.Encoding.Default.GetBytes(String.Format("{0}:{1}", Global.WHMUser, Global.WHMPass))));
        req.PreAuthenticate = true;
        req.AuthenticationLevel = System.Net.Security.AuthenticationLevel.MutualAuthRequested;
        req.Headers.Add("Authorization", auth);

        WebResponse resp = req.GetResponse();
        Stream receiveStream = resp.GetResponseStream();
        StreamReader reader = new StreamReader(receiveStream, Encoding.UTF8);
[B]        String strResponse = reader.ReadToEnd();[/B]

        return strResponse;
    }

The bold line throws an exception every single time only when using the createaccount or un/suspendaccount functions. None of the other 20 method names that we have tried cause the error (like generate csr, install IPs, etc).

seems wierd that its always these two that cause the error - and always the same error on the same line.

Can you provide the code you are using, or perhaps a tweak to what we are doing above?

 

[Eric]

Howdy,

I removed the trailing & from your request and I was able to make it work in my test program.

Thanks!

 

[B12Org]

I removed the trailing ampersand and the problem still persists.

Unable to read data from the transport connection: The connection was closed.

 

[Eric]

Howdy,

For the sake of testing would you try using the non https ports? I'd like to rule out your https/self-signed certificate code. If you'd like to encrypt the data you can still use an ssh tunnel via putty.

Thanks!

 

[B12Org]

Eric,

Actually we are not using SSL atm, so these errors are not specific to ports unfortunately.

 

[MattDees]

Eric,

Actually we are not using SSL atm, so these errors are not specific to ports unfortunately.

When you make this connection, does anything come up in /usr/local/cpanel/logs/access_log or /usr/local/cpanel/logs/error_log

 

[B12Org]

access log yes

63.229.62.199 - root [09/10/2010:17:19:15 -0000] "GET /xml-api/createacct?username=myuser3&password=__HIDDEN__&[email protected]&domain=myuser3.somedomain.com&cpmod=x3&quota=0&bwlimit=0&ip=n&cgi=1&frontpage=0&hasshell=0&maxftp=unlimited&maxsql=unlimited&maxpop=0&maxlst=0&maxsub=unlimited&featurelist=default&maxpark=unlimited&maxaddon=unlimited&useregns=0&reseller=0&mxcheck=remote HTTP/1.1" 200 0 "" ""

error log no