netcup-node
TypeScript icon, indicating that this package has built-in type declarations

0.0.13 • Public • Published

Netcup-node

codecov Known Vulnerabilities build Maintainability Rating Bugs Code Smells GitHub last commit npm npm

A node wrapper for the Netcup CCP API.

Docs: https://proohit.github.io/netcup-node/

Current support

  • only JSON Rest API, no SOAP yet
  • auto auth handling with support to use custom auth handling
  • functions
    • login
    • infoDnsZone
    • infoDnsRecord
    • updateDnsRecords
    • updateDnsRecordWithCurrentIp to set the current public ip as destination. Works with ipv4 and ipv6. Default updates ipv4 only. Set parameter useIpv6Only to true to update ipv6 only. Set parameter useIpv4AndIpv6 to true to update both ipv4 and ipv6. NOTE: Uses public-ip package to get the current public ip.
  • error handling: on any response that isn't 2000 from Netcup, an error with the longmessage from Netcup is thrown

ToDo

  • login
  • infoDnsZone
  • infoDnsRecord
  • updateDnsRecords (0.0.5)
  • updateDnsRecordWithCurrentIp (0.0.6)
  • logout
  • reseller api functions
  • different formats

Getting started

Installation

npm install --save netcup-node

Authentication

You will also need three things from Netcup CCP:

  • apikey
  • apipassword
  • customernumber

After logging in to Netcup CCP, navigate to Stammdaten and create the key/password there. The customernumber is next to your name at the top of the CCP.

Usage

The default exported NetcupApi is a wrapper around the actual api. It handles authentication and passes parameters to the implemented api.

ESM

import NetcupApi from 'netcup-node';
const api = await new NetcupApi().init({
  apikey: 'YOUR_API_KEY',
  apipassword: 'YOUR_API_PASSWORD',
  customernumber: 'YOUR_CUSTOMER_NUMBER',
});
const dnsInfo = await api.infoDnsZone({ domainname: 'YOUR.DOMAIN' });

If you prefer, you can use the NetcupRestApi directly, without using the integrated authentication state handling from the default exported NetcupApi.

import { NetcupRestApi } from 'netcup-node';
const api = new NetcupRestApi();
const authResponse = await api.login({
  apikey: '',
  apipassword: '',
  customernumber: '',
});
const dnsRecords = await api.infoDnsRecords({
  apisessionid: authResponse.responsedata.apisessionid,
  apikey: 'YOUR_API_KEY',
  customernumber: 'YOUR_CUSTOMER_NUMBER',
  domainname: 'YOUR.DOMAIN',
});

CJS

const NetcupApi = require('netcup-node').default;
// or const { NetcupApi } = require('netcup-node');

const api = await new NetcupApi().init({
  apikey: 'YOUR_API_KEY',
  apipassword: 'YOUR_API_PASSWORD',
  customernumber: 'YOUR_CUSTOMER_NUMBER',
});
const dnsInfo = await api.infoDnsZone({ domainname: 'YOUR.DOMAIN' });

Readme

Keywords

Package Sidebar

Install

npm i netcup-node

Weekly Downloads

0

Version

0.0.13

License

MIT

Unpacked Size

44.1 kB

Total Files

41

Last publish

Collaborators

  • proohit