Star Wars Combine :: Game Guide - User contributions [en]

API: Handle verification

2017-09-18T06:18:52Z

Olwin Froon: /* Handle check resource */

<< [[API: Getting started]]

== API: Handle verification ==

Whatever your application does, it probably allows for SWC players to sign up.

You might want to know if a handle actually exists in SWC.

== Handle check resource ==

The character handle you wish to verify needs to be passed via URL.

'''/handle/[characterHandle]'''

Note, that

a) you need to URL-encode it and

b) upper/lower case doesn't matter.

If you pass an invalid handle

http://www.swcombine.com/ws/v1.0/handle/iMadeThisUp

the response will be an error message accompanied by a 404 HTTP result code:

<pre>
<error>Not Found</error>
</pre>

If the handle is actually valid ''and'' properly encoded

http://www.swcombine.com/ws/v1.0/handle/olwin%2Bfroon

you'll see something like this:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<handlecheck xmlns="[...]" version="1.0" timestamp-swc="[swcTime]">
<uid>1:1190612</uid>
<handle>Olwin Froon</handle>
</handlecheck>
</pre>

The response provides the character's UID (a unique entity identifier) as well as the handle itself in proper upper/lower case writing.

For anything else you want to do with that character, you need their UID, so make sure you store it in a suitable place.

API: Getting started

2017-09-18T06:17:38Z

Olwin Froon: /* API root */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation.

It comes in handy once in a while, but for now you can safely ignore it.

You might think that's an impressive list of features. It is. Unfortunately, a lot of them don't work. But a few very useful ones do.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert a <code>timestamp-swc</code> into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

Okay, that was easy, wasn't it? Now let's try [[API:_Handle_verification|something ''really'' useful]].

API: Handle verification

2015-12-01T07:59:30Z

Olwin Froon:

<< [[API: Getting started]]

== API: Handle verification ==

Whatever your application does, it probably allows for SWC players to sign up.

You might want to know if a handle actually exists in SWC.

== Handle check resource ==

The character handle you wish to verify needs to be passed via URL.

'''/handle/[characterHandle]'''

Note, that

a) you need to URL-encode it twice and

b) upper/lower case doesn't matter.

If you pass an invalid handle

http://www.swcombine.com/ws/v1.0/handle/iMadeThisUp

the response will be an error message accompanied by a 404 HTTP result code:

<pre>
<error>Not Found</error>
</pre>

If the handle is actually valid ''and'' properly encoded

http://www.swcombine.com/ws/v1.0/handle/olwin%2Bfroon

you'll see something like this:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<handlecheck xmlns="[...]" version="1.0" timestamp-swc="[swcTime]">
<uid>1:1190612</uid>
<handle>Olwin Froon</handle>
</handlecheck>
</pre>

The response provides the character's UID (a unique entity identifier) as well as the handle itself in proper upper/lower case writing.

For anything else you want to do with that character, you need their UID, so make sure you store it in a suitable place.

API: Handle verification

2015-12-01T07:53:27Z

Olwin Froon: /* API: Handle verification */

Previous page: [[API: Getting started]]

== API: Handle verification ==

Whatever your application does, it probably allows for SWC players to sign up.

You might want to know if a handle actually exists in SWC.

== Handle check resource ==

The character handle you wish to verify needs to be passed via URL.

'''/handle/[characterHandle]'''

Note, that

a) you need to URL-encode it twice and

b) upper/lower case doesn't matter.

If you pass an invalid handle

http://www.swcombine.com/ws/v1.0/handle/iMadeThisUp

the response will be an error message accompanied by a 404 HTTP result code:

<pre>
<error>Not Found</error>
</pre>

If the handle is actually valid ''and'' properly encoded

http://www.swcombine.com/ws/v1.0/handle/olwin%2Bfroon

you'll see something like this:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<handlecheck xmlns="[...]" version="1.0" timestamp-swc="[swcTime]">
<uid>1:1190612</uid>
<handle>Olwin Froon</handle>
</handlecheck>
</pre>

The response provides the character's UID (a unique entity identifier) as well as the handle itself in proper upper/lower case writing.

For anything else you want to do with that character, you need their UID, so make sure you store it in a suitable place.

User:Olwin Froon

2015-12-01T07:52:34Z

Olwin Froon:

Current work:

- [[API: Getting started]]

- [[API: Handle verification]]

User:Olwin Froon

2015-12-01T07:52:22Z

Olwin Froon:

Current work:
- [[API: Getting started]]
- [[API: Handle verification]]

API: Handle verification

2015-12-01T07:50:46Z

Olwin Froon: /* Handle check resource */

== API: Handle verification ==

Whatever your application does, it probably allows for SWC players to sign up.

You might want to know if a handle actually exists in SWC.

== Handle check resource ==

The character handle you wish to verify needs to be passed via URL.

'''/handle/[characterHandle]'''

Note, that

a) you need to URL-encode it twice and

b) upper/lower case doesn't matter.

If you pass an invalid handle

http://www.swcombine.com/ws/v1.0/handle/iMadeThisUp

the response will be an error message accompanied by a 404 HTTP result code:

<pre>
<error>Not Found</error>
</pre>

If the handle is actually valid ''and'' properly encoded

http://www.swcombine.com/ws/v1.0/handle/olwin%2Bfroon

you'll see something like this:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<handlecheck xmlns="[...]" version="1.0" timestamp-swc="[swcTime]">
<uid>1:1190612</uid>
<handle>Olwin Froon</handle>
</handlecheck>
</pre>

The response provides the character's UID (a unique entity identifier) as well as the handle itself in proper upper/lower case writing.

For anything else you want to do with that character, you need their UID, so make sure you store it in a suitable place.

API: Handle verification

2015-12-01T07:49:38Z

Olwin Froon: /* Handle check resource */

API: Getting started

2015-12-01T07:48:56Z

Olwin Froon: /* A first sample */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, there's a working copy on [[http://dev.swcombine.com/ws/v1.0/developers/index.php the dev server]].)

It comes in handy once in a while, but for now you can safely ignore it.

You might think that's an impressive list of features. It is. Unfortunately, a lot of them don't work. But a few very useful ones do.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert a <code>timestamp-swc</code> into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

Okay, that was easy, wasn't it? Now let's try [[API:_Handle_verification|something ''really'' useful]].

API: Getting started

2015-12-01T07:47:29Z

Olwin Froon: /* API root */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, there's a working copy on [[http://dev.swcombine.com/ws/v1.0/developers/index.php the dev server]].)

It comes in handy once in a while, but for now you can safely ignore it.

You might think that's an impressive list of features. It is. Unfortunately, a lot of them don't work. But a few very useful ones do.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert a <code>timestamp-swc</code> into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

Okay, that was easy, wasn't it? Now let's try [[API:_Handle_verification|something ''really'' useful]].

API: Handle verification

2015-07-28T18:56:15Z

Olwin Froon: /* Handle check resource */

== API: Handle verification ==

Whatever your application does, it probably allows for SWC players to sign up.

You might want to know if a handle actually exists in SWC.

== Handle check resource ==

The character handle you wish to verify needs to be passed via URL.

'''/handle/[characterHandle]'''

Note, that

a) you need to URL-encode it twice and

b) upper/lower case doesn't matter.

If you pass an invalid handle

http://www.swcombine.com:8081/ws/v1.0/handle/iMadeThisUp

the response will be an error message accompanied by a 404 HTTP result code:

<pre>
<error>Not Found</error>
</pre>

If the handle is actually valid ''and'' properly encoded

http://www.swcombine.com:8081/ws/v1.0/handle/olwin%2Bfroon

you'll see something like this:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<handlecheck xmlns="[...]" version="1.0" timestamp-swc="[swcTime]">
<uid>1:1190612</uid>
<handle>Olwin Froon</handle>
</handlecheck>
</pre>

The response provides the character's UID (a unique entity identifier) as well as the handle itself in proper upper/lower case writing.

For anything else you want to do with that character, you need their UID, so make sure you store it in a proper place.

API: Handle verification

2015-07-28T18:54:35Z

Olwin Froon: Created page with '== API: Handle verification == Whatever your application does, it probably allows for SWC players to sign up. You might want to know if a handle actually exists in SWC. == …'

== API: Handle verification ==

Whatever your application does, it probably allows for SWC players to sign up.

You might want to know if a handle actually exists in SWC.

== Handle check resource ==

The character handle you wish to verify needs to be passed via URL.

'''/handle/[characterHandle]'''

Note, that

a) you need to URL-encode it twice and

b) upper/lower case doesn't matter.

If you pass an invalid handle

http://www.swcombine.com:8081/ws/v1.0/handle/iMadeThisUp

the response will be an error message accompanied by a 404 HTTP result code:

<pre>
<error>Not Found</error>
</pre>

If the handle is actually valid

http://www.swcombine.com:8081/ws/v1.0/handle/olwin%2Bfroon

you'll see something like this:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<handlecheck xmlns="[...]" version="1.0" timestamp-swc="[swcTime]">
<uid>1:1190612</uid>
<handle>Olwin Froon</handle>
</handlecheck>
</pre>

The response provides the character's UID (a unique entity identifier) as well as the handle itself in proper upper/lower case writing.

For anything else you want to do with that character, you need their UID, so make sure you store it in a proper place.

API: Getting started

2015-07-28T18:44:26Z

Olwin Froon:

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, there's a working copy on [[http://dev.swcombine.com/ws/v1.0/developers/index.php the dev server]].)

It comes in handy once in a while, but for now you can safely ignore it.

You might think that's an impressive list of features. It is. Unfortunately, a lot of them don't work. But a few very useful ones do.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert a <code>timestamp-swc</code> into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

Okay, that was easy, wasn't it? Now let's try [[API:_Handle_verification|something ''really'' useful]].

API: Getting started

2015-07-28T18:40:54Z

Olwin Froon: /* API root */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, there's a working copy on [[http://dev.swcombine.com/ws/v1.0/developers/index.php the dev server]].)

It comes in handy once in a while, but for now you can safely ignore it.

You might think that's an impressive list of features. It is. Unfortunately, a lot of them don't work. But a few very useful ones do.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert a <code>timestamp-swc</code> into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

API: Getting started

2015-02-14T14:48:45Z

Olwin Froon: /* A first sample */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, there's a working copy on [[http://dev.swcombine.com/ws/v1.0/developers/index.php the dev server]].)

Lots and lots of XML stuff. It does come in handy once in a while, but for now you can safely ignore it.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert a <code>timestamp-swc</code> into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

API: Getting started

2015-02-14T14:01:01Z

Olwin Froon: /* API root */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, there's a working copy on [[http://dev.swcombine.com/ws/v1.0/developers/index.php the dev server]].)

Lots and lots of XML stuff. It does come in handy once in a while, but for now you can safely ignore it.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert an SWC timestamp into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

API: Getting started

2015-02-13T17:30:46Z

Olwin Froon: /* A first sample */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, sign up on [[http://dev.swcombine.com the dev server]] and [[http://dev.swcombine.com/ws/v1.0/developers/index.php check this]])

Lots and lots of XML stuff. It does come in handy once in a while, but for now you can safely ignore it.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert an SWC timestamp into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

API: Getting started

2015-02-13T17:30:34Z

Olwin Froon: /* API root */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, sign up on [[http://dev.swcombine.com the dev server]] and [[http://dev.swcombine.com/ws/v1.0/developers/index.php check this]])

Lots and lots of XML stuff. It does come in handy once in a while, but for now you can safely ignore it.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert an SWC timestamp into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

API: Getting started

2015-02-13T17:30:22Z

Olwin Froon: /* API root */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, sign up on [[http://dev.swcombine.com the dev server]] and [[http://dev.swcombine.com/ws/v1.0/developers/index.php check this]])

Lots and lots of XML stuff. It does come in handy once in a while, but for now you can safely ignore it.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert an SWC timestamp into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

API: Getting started

2015-02-13T17:26:23Z

Olwin Froon: /* API root */

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, sign up on [[http://dev.swcombine.com the dev server]] and [[http://dev.swcombine.com/ws/v1.0/developers/index.php check this]])

Lots and lots of XML stuff. It does come in handy once in a while, but for now you can safely ignore it.

== A first sample ==

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert an SWC timestamp into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

API: Getting started

2015-02-13T17:25:54Z

Olwin Froon: Created page with '== API? == API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already. The Combine API allows direct access to the Combine's database fro…'

== API? ==

API means '''A'''pplication '''P'''rogramming '''I'''nterface, but you probably knew that already.

The Combine API allows direct access to the Combine's database from your application program.
Not all of it, though, and not right away, it's not that simple.

There are public resources and there are private resources.

"Private" means, you'd access via a specific character's scope. That requires proper authentication, of course, and it's not exactly trivial.

So we'll focus on a few public resources for now, not only to get into the right mood but also because there's quite some nifty stuff available.

== API root ==

You access the API via a directory tree on the SWC website. Root directory is

http://www.swcombine.com:8081/ws/v1.0/

Yes, give it a try. It won't explode in your face ... I hope. Not often, anyway.

The XML response to this URI is the API's index resource, which also poses as source code for the documentation, which is currently unavailable on the main server.

(If you insist on seeing it, sign up on [[http://dev.swcombine.com the dev server]] and [[http://dev.swcombine.com/ws/v1.0/developers/index.php check this]])

Lots and lots of XML stuff. It does come in handy once in a while, but for now you can safely ignore it.

Let's dig a wee bit deeper and try one of the public resources. No, not "hello world", but:

http://www.swcombine.com:8081/ws/v1.0/api/time/real/

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<timereal xmlns="http://www.swcombine.com/ws/timereal-ns/" version="1.0" timestamp-swc="[swcTime]">
<timestamp-unix>[realTime]</timestamp-unix>
</timereal>
</pre>

There we go.

All API responses follow the same pattern:
There is a proper XML header and a root element with a unique name, suitable to identify the resource you're looking at, and a few standard attributes like

- the XML name space <code>xmlns</code>

- the API version <code>version</code> and

- the SWC timestamp <code>timestamp-swc</code>, when this response was created.

Note that <code>timestamp-swc</code> is SWC's variant of unix time.

You will discover, that you can convert an SWC timestamp into a regular unix timestamp by adding a constant value of 912668400.

So, whenever you encounter a <code>timestamp-swc</code>, you'll know what to do.

User:Olwin Froon

2015-02-13T17:04:10Z

Olwin Froon:

Current work: [[API: Getting started]]

User:Olwin Froon

2015-02-13T17:00:00Z

Olwin Froon: Created page with 'Current work: [API guide]'

Current work: [API guide]