# Account and Handling

## login

### Login with Username & Password

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> </span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Requires (mandatory):**</span>

<table border="1" id="bkmrk-username-joker.com-u" style="width: 80%;"><tbody><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">username</span>*</td><td><span style="font-family: arial,helvetica,sans-serif; font-size: small;"> Joker.com username (email address)</span></td></tr><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">password</span>*</td><td><span style="font-family: arial,helvetica,sans-serif; font-size: small;">Joker.com password</span></td></tr></tbody></table>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> **Returns:**</span>

<table border="1" id="bkmrk-auth-sid-authenticat" style="width: 80%;"><tbody><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">Auth-SID</span>*</td><td><span style="font-family: arial,helvetica,sans-serif; font-size: small;">Authenticated Session ID, must be provided with any other request (parameter *auth-sid*)  
</span></td></tr><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">List of TLDs</span>*</td><td><span style="font-family: arial,helvetica,sans-serif; font-size: small;">List of domain TLDs which are available to the reseller.</span></td></tr></tbody></table>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> To be able to use the entire API, you must have a reseller account with Joker.com (and use this account to log in). </span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> </span><span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Example:**</span>

`<span style="font-size: small; font-family: courier new,courier;">  https://dmapi.joker.com/request/login?username=johndoe&password=mypass</span>`

### Login with API Keys

Instead of using your user- and password credentials, you may also use so called '**API keys**' for login. This way, you can create several DMAPI access facilities, which has several advantages:

- you do not need to expose username and password in your scripts
- API keys **can be restricted** to be "read only" (no modifications possible), or to allow 'modifications only' (can not produce costs)
- you may hand API keys to your staff to enable them to do specific things with Joker.com

Create your API keys in '[**My Profile**](https://joker.com/goto/myjoker)' in section '**Manage Joker.com API access keys**'

Example usage:

```
https://dmapi.joker.com/request/login?api-key=Key_created_in_your_Profile_at_Joker.com
```

The result is the same as for "login"-request, you have to use the provided auth-sid for the subsequent actions.

## logout

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Returns: Nothing** </span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">Used to forcibly close (terminate) a session. The session identified by Auth-SID may not be used anymore to send requests. Normally not required as session will timeout anyway (default: 1 hour).</span>

## result-list

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Accepts:** </span>

<table border="0" id="bkmrk-pending%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0-get-res" style="width: 643px; height: 271px;"><tbody><tr><td>*pending* </td><td>get results of requests still in progress

</td></tr><tr><td>*showall*</td><td>get all results incl. deletes using result-delete</td></tr><tr><td>*period*</td><td>get results for specifed period of days (default: 90)

</td></tr><tr><td>*date*</td><td>get results received on (or before) specified date. When date is specified, parameter "period" will be applied to this date (instead of today) and defaults to 1</td></tr><tr><td>*offset*</td><td>start dispalying results from specified position

</td></tr><tr><td>*limit*</td><td>only get number of results specified by limit</td></tr><tr><td>*status*</td><td>get results having specified status (ack/nack/?)

</td></tr><tr><td>*count-only* </td><td>when set to 1, only count number of records and return single line in format "Records: N"

</td></tr><tr><th colspan="2">All following filters may use patterns ("\*" and "?")

</th></tr><tr><td>*rtype*

</td><td>get results for requests of specified type (domain-register/etc)</td></tr><tr><td>*objid*</td><td>get results for specified object ids (domain names, contacts, hosts)

</td></tr><tr><td>*procid*</td><td>get results for specified proc-id</td></tr><tr><td>*svtrid*</td><td>get results for specifued SvTrId</td></tr><tr><td>*cltrid*</td><td>get results for specified ClTrId</td></tr></tbody></table>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> </span><span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Returns:**</span>

List of answers from joker.com (one per line):<span style="font-family: arial,helvetica,sans-serif; font-size: small;">  
</span>

```
TimeStamp SvTrId Proc-ID request-type status ClTrId
```

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Where:**</span>

```
TimeStamp: The time when request was made, YYYYMMDDHHMMSS
SvTrID: Tracking-Id associated with this request.
Proc-ID: Proc-Id associated with this request.
request-type: The type of the request.
request-object: The object name (host, domain or contact handle)
status: ack, nack or ?, where ack means that request was completed successfully.
ClTrId: User specified transaction ID, or "-" if nothing was provided by the user
```

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> </span>**Example:**

```
https://dmapi.joker.com/request/result-list?auth-sid=20ddb8c3b2ea758dcf9fa4c7f46c0784
```

## result-retrieve

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Accepts:**</span>

<table border="1" id="bkmrk-proc-id-one-of-these" style="width: 80%;"><tbody><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">Proc-ID</span>*</td><td rowspan="2"><span style="font-family: arial,helvetica,sans-serif; font-size: small;">One of these must be specified. If both are specified, SvTrId has precedence.</span></td></tr><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">SvTrID</span>*</td></tr></tbody></table>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Returns:**</span>

<table border="1" id="bkmrk-answer-%28processing-r" style="width: 80%;"><tbody><tr><td><span style="font-family: arial,helvetica,sans-serif; font-size: small;">Answer (processing result) associated with specified Tracking/Processing ID. </span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">If detailed information (content) is not available, only status will be returned</span>

</td></tr></tbody></table>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Please note:** </span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">Since there is no requirement of uniqueness for user-specified transaction ids, it is not possible to use them to retrieve specific results. </span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Example:**</span>

`<span style="font-size: small; font-family: courier new,courier;">  https://dmapi.joker.com/request/result-retrieve?proc-id=8181810&auth-sid=<your-current-session-id></span>`

## result-delete<span style="font-family: arial,helvetica,sans-serif; font-size: small;">   
</span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Accepts:**</span>

<table border="1" id="bkmrk-proc-id-one-of-these-1" style="width: 80%;"><tbody><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">Proc-ID</span>*

</td><td rowspan="2"><span style="font-family: arial,helvetica,sans-serif; font-size: small;">One of these must be specified. If both are specified, SvTrId has precedence</span>

</td></tr><tr><td>*<span style="font-family: arial,helvetica,sans-serif; font-size: small;">SvTrID</span>*

</td></tr></tbody></table>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Returns:**</span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> A descriptive message (confirmation) in case of success.  
  
This request will delete the content (not the status) of a reply to an asynchronous request. Deleted results will not be listed anymore when using *result-list*.</span>

## query-profile <span style="font-family: arial,helvetica,sans-serif; font-size: small;">  
</span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;">**Returns:**</span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> Returns reseller profile data in format "key: value". May be used to query account balance</span>

<span style="font-family: arial,helvetica,sans-serif; font-size: small;"> </span>Example:

```
https://dmapi.joker.com/request/query-profile?auth-sid=20ddb8c3b2ea758dcf9fa4c7f46c0784
```