https://github.com/domeneshop/domeneshop.js
Javascript library for the Domeneshop API
https://github.com/domeneshop/domeneshop.js
api-client domain-name-system javascript node-module
Last synced: 4 months ago
JSON representation
Javascript library for the Domeneshop API
- Host: GitHub
- URL: https://github.com/domeneshop/domeneshop.js
- Owner: domeneshop
- License: mit
- Created: 2019-04-17T12:34:14.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-08T01:36:45.000Z (about 1 year ago)
- Last Synced: 2025-10-05T22:42:23.537Z (8 months ago)
- Topics: api-client, domain-name-system, javascript, node-module
- Language: JavaScript
- Size: 217 KB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# domeneshop.js
Javascript library for the Domeneshop API.
## Installation
```
npm install domeneshop.js
```
## Credentials
Use of this module requires Domeneshop API credentials.
You need an API token and secret. See the [Domeneshop API](https://api.domeneshop.no/docs/) documentation for more information.
**CAUTION:** You should protect these API credentials as you would the password to your Domeneshop user account. Users who can read this information can use these credentials to issue arbitrary API calls on your behalf.
## Usage example
```javascript
const Domeneshop = require('domeneshop.js');
const api = new Domeneshop("","");
api.getDomains().then((domains) => {
for(let domain of domains) {
api.dns.getRecords(domain.id).then((record) => {
console.log(domain.domain);
console.log(record);
});
}
}).catch((err)=>{
console.error(err);
});
```
## domeneshop.js API
### `new Domeneshop(token, secret)`
Creates a new Domeneshop API instance.
### `Domeneshop.getDomain(domainId)`
Get information about one of your domains.
#### Returns:
```json
{
"domain": "example.com",
"expiry_date": "2120-01-01",
"id": 1234567890,
"nameservers": [
"ns1.hyp.net",
"ns2.hyp.net",
"ns3.hyp.net"
],
"registered_date": "1990-01-01",
"registrant": "ICANN",
"renew": true,
"services":
{
"dns": true,
"email": false,
"registrar": true,
"webhotel": "none"
},
"status": "active"
}
```
### `Domeneshop.getDomains()`
List all domains on your account.
Returns a list of objects in the same shape as `getDomain(domainId)`.
### `Domeneshop.dns`
This namespace contains all methods to manipulate DNS records for domains.
### `Domeneshop.dns.getRecord(domainId, recordId)`
Get a specific DNS record for a domain.
**Note:**: The host field does not include the domain name. An A record for `www.example.com` should only have `www` in its host field.
#### Returns:
```json
{
"data": "127.0.0.1",
"host": "www",
"id": 1591030,
"ttl": 3600,
"type": "A"
}
```
### `Domeneshop.dns.getRecords(domainId)`
List all DNS records for a domain.
### `Domeneshop.dns.createRecord(domainId, record)`
Creates a new DNS record for a domain. The record format is JSON with required parameters like the one returned from **getRecord**.
For full definition see the TypeScript interfaces defined in [src/lib/interfaces/dnsrecord.ts](src/lib/interfaces/dnsrecord.ts)
### `Domeneshop.dns.modifyRecord(domainId, recordId, record)`
Modifies a specific DNS record for a domain.
**Note:** You can't modify the host nor the type field. If you want to modify these fields, delete the existing DNS record and recreate it.
### `Domeneshop.dns.deleteRecord(domainId, recordId)`
Deletes a specific DNS record for a domain.
### `Domeneshop.forwards`
This namespace contains all methods to manipulate http 301 forwarding for host names on domains.
### `Domeneshop.forwards.getForward(domainId, host)`
Get a specific forwarding for a host name.
**Note:**: The host field does not include the domain name. A forwarding for `www.example.com` should only have `www` in its host field.
#### Returns:
```json
{
"host": "www",
"frame": false,
"url": "http://example.com/"
}
```
### `Domeneshop.forwards.getForwards(domainId)`
List all forwardings for a domain.
### `Domeneshop.forwards.createForward(domainId, forward)`
Creates a new forwarding for a host name on a domain. The record format is JSON with required parameters like the one returned from **getForward**.
### `Domeneshop.forwards.modifyForward(domainId, host, forward)`
Modifies a specific forwardings for a host name on a domain.
**Note:** You can't modify the host field. If you want to modify this field, delete the existing forwarding and recreate it.
### `Domeneshop.forwards.deleteForward(domainId, host)`
Deletes a specific forwarding for a host name on a domain.
### `Domeneshop.invoices`
This namespace contains all methods to read invoice information on an account.
### `Domeneshop.invoices.getInvoice(invoiceID)`
Get one invoice.
#### Returns:
```json
{
"amount": 120,
"currency": "NOK",
"due_date": "2097-11-14",
"id": 1,
"issued_date": "2097-10-30",
"paid_date": "2098-11-10",
"status": "paid",
"type": "invoice",
"url": "https://domene.shop/invoice?nr=1"
}
```
### `Domeneshop.invoices.getInvoices(status)`
List all invoices for an account. Might be filtered by `status`.
`status` is optional, and might be one of "paid", "unpaid" or "settled". "settled" means the invoice is settled by a credit note.